From fdf4f48784e8fa2933d0ecbda76575b905f2089c Mon Sep 17 00:00:00 2001 From: Jan Kadlec Date: Fri, 11 Apr 2025 13:50:31 +0200 Subject: [PATCH 1/3] chore: regenerate api client JIRA: TRIVIAL risk: low --- gooddata-api-client/.openapi-generator/FILES | 60 +- gooddata-api-client/README.md | 51 +- gooddata-api-client/docs/ActionsApi.md | 98 +- gooddata-api-client/docs/AdHocAutomation.md | 2 +- gooddata-api-client/docs/AfmCancelTokens.md | 13 + .../docs/AutomationMetadata.md | 14 + gooddata-api-client/docs/AutomationsApi.md | 50 +- gooddata-api-client/docs/ComputationApi.md | 8 +- .../docs/ContentSlideTemplate.md | 15 + .../docs/CoverSlideTemplate.md | 16 + .../docs/DashboardSlidesTemplate.md | 17 + .../docs/DeclarativeAutomation.md | 2 +- .../docs/DeclarativeExportTemplate.md | 16 + .../docs/DeclarativeExportTemplates.md | 13 + .../docs/DeclarativeOrganization.md | 1 + .../docs/DeclarativeOrganizationInfo.md | 1 + gooddata-api-client/docs/EntitiesApi.md | 718 ++++++- gooddata-api-client/docs/ExecutionSettings.md | 1 + .../docs/GetSlidesExport202ResponseInner.md | 19 + .../docs/IntroSlideTemplate.md | 17 + .../docs/JsonApiAutomationInAttributes.md | 2 +- .../JsonApiAutomationInAttributesMetadata.md | 14 + .../docs/JsonApiAutomationOutAttributes.md | 2 +- .../docs/JsonApiExportTemplateIn.md | 15 + .../docs/JsonApiExportTemplateInAttributes.md | 14 + ...lateInAttributesDashboardSlidesTemplate.md | 17 + ...emplateInAttributesWidgetSlidesTemplate.md | 14 + .../docs/JsonApiExportTemplateInDocument.md | 12 + .../docs/JsonApiExportTemplateOut.md | 15 + .../docs/JsonApiExportTemplateOutDocument.md | 13 + .../docs/JsonApiExportTemplateOutList.md | 15 + .../docs/JsonApiExportTemplateOutWithLinks.md | 15 + .../docs/JsonApiExportTemplatePatch.md | 15 + .../JsonApiExportTemplatePatchAttributes.md | 14 + .../JsonApiExportTemplatePatchDocument.md | 12 + .../JsonApiExportTemplatePostOptionalId.md | 15 + ...ApiExportTemplatePostOptionalIdDocument.md | 12 + .../docs/JsonApiOrganizationInAttributes.md | 1 + .../docs/JsonApiOrganizationOutAttributes.md | 1 + gooddata-api-client/docs/LayoutApi.md | 311 ++- .../docs/NotificationChannelsApi.md | 205 ++ .../docs/OrganizationControllerApi.md | 6 + .../docs/OrganizationDeclarativeAPIsApi.md | 86 +- .../docs/OrganizationEntityAPIsApi.md | 6 + .../docs/OrganizationModelControllerApi.md | 682 +++++++ gooddata-api-client/docs/RawExportApi.md | 1 + gooddata-api-client/docs/RunningSection.md | 14 + .../docs/SectionSlideTemplate.md | 15 + ...ideshowExportApi.md => SlidesExportApi.md} | 31 +- .../docs/SlidesExportRequest.md | 4 +- gooddata-api-client/docs/VisibleFilter.md | 13 + .../docs/WidgetSlidesTemplate.md | 14 + .../docs/WorkspaceObjectControllerApi.md | 30 +- .../docs/WorkspacesDeclarativeAPIsApi.md | 10 +- .../gooddata_api_client/api/actions_api.py | 158 ++ .../api/computation_api.py | 6 + .../gooddata_api_client/api/entities_api.py | 963 ++++++++- .../gooddata_api_client/api/layout_api.py | 252 +++ .../api/notification_channels_api.py | 252 +++ .../api/organization_model_controller_api.py | 959 ++++++++- ...how_export_api.py => slides_export_api.py} | 3 +- .../gooddata_api_client/apis/__init__.py | 2 +- .../model/ad_hoc_automation.py | 10 +- .../model/afm_cancel_tokens.py | 270 +++ .../model/api_entitlement.py | 1 + .../model/automation_metadata.py | 276 +++ .../model/content_slide_template.py | 278 +++ .../model/cover_slide_template.py | 282 +++ .../model/dashboard_slides_template.py | 305 +++ .../model/declarative_automation.py | 10 +- .../model/declarative_export_template.py | 300 +++ .../model/declarative_export_templates.py | 276 +++ .../model/declarative_organization.py | 6 + .../model/declarative_organization_info.py | 4 + .../model/declarative_setting.py | 1 + .../model/entitlements_request.py | 1 + .../model/execution_settings.py | 4 + .../get_slides_export202_response_inner.py | 292 +++ .../model/intro_slide_template.py | 286 +++ .../json_api_automation_in_attributes.py | 10 +- ...n_api_automation_in_attributes_metadata.py | 276 +++ .../json_api_automation_out_attributes.py | 10 +- .../json_api_data_source_out_attributes.py | 1 + .../model/json_api_export_template_in.py | 298 +++ .../json_api_export_template_in_attributes.py | 289 +++ ...in_attributes_dashboard_slides_template.py | 305 +++ ...te_in_attributes_widget_slides_template.py | 287 +++ .../json_api_export_template_in_document.py | 276 +++ .../model/json_api_export_template_out.py | 298 +++ .../json_api_export_template_out_document.py | 282 +++ .../json_api_export_template_out_list.py | 290 +++ ...json_api_export_template_out_with_links.py | 349 ++++ .../model/json_api_export_template_patch.py | 298 +++ ...on_api_export_template_patch_attributes.py | 283 +++ ...json_api_export_template_patch_document.py | 276 +++ ...on_api_export_template_post_optional_id.py | 296 +++ ...port_template_post_optional_id_document.py | 276 +++ .../json_api_organization_in_attributes.py | 4 + .../json_api_organization_out_attributes.py | 4 + ..._api_organization_setting_in_attributes.py | 1 + .../model/resolved_setting.py | 1 + .../model/running_section.py | 268 +++ .../model/section_slide_template.py | 278 +++ .../model/slides_export_request.py | 28 +- .../model/visible_filter.py | 268 +++ .../model/widget_slides_template.py | 287 +++ .../gooddata_api_client/models/__init__.py | 28 + schemas/gooddata-afm-client.json | 92 +- schemas/gooddata-api-client.json | 1814 ++++++++++++++--- schemas/gooddata-automation-client.json | 30 +- schemas/gooddata-export-client.json | 104 +- schemas/gooddata-metadata-client.json | 1165 ++++++++++- 112 files changed, 16327 insertions(+), 420 deletions(-) create mode 100644 gooddata-api-client/docs/AfmCancelTokens.md create mode 100644 gooddata-api-client/docs/AutomationMetadata.md create mode 100644 gooddata-api-client/docs/ContentSlideTemplate.md create mode 100644 gooddata-api-client/docs/CoverSlideTemplate.md create mode 100644 gooddata-api-client/docs/DashboardSlidesTemplate.md create mode 100644 gooddata-api-client/docs/DeclarativeExportTemplate.md create mode 100644 gooddata-api-client/docs/DeclarativeExportTemplates.md create mode 100644 gooddata-api-client/docs/GetSlidesExport202ResponseInner.md create mode 100644 gooddata-api-client/docs/IntroSlideTemplate.md create mode 100644 gooddata-api-client/docs/JsonApiAutomationInAttributesMetadata.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateIn.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateInAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateInDocument.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateOut.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateOutDocument.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateOutList.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplateOutWithLinks.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplatePatch.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplatePatchAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplatePatchDocument.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplatePostOptionalId.md create mode 100644 gooddata-api-client/docs/JsonApiExportTemplatePostOptionalIdDocument.md create mode 100644 gooddata-api-client/docs/RunningSection.md create mode 100644 gooddata-api-client/docs/SectionSlideTemplate.md rename gooddata-api-client/docs/{SlideshowExportApi.md => SlidesExportApi.md} (82%) create mode 100644 gooddata-api-client/docs/VisibleFilter.md create mode 100644 gooddata-api-client/docs/WidgetSlidesTemplate.md rename gooddata-api-client/gooddata_api_client/api/{slideshow_export_api.py => slides_export_api.py} (99%) create mode 100644 gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.py create mode 100644 gooddata-api-client/gooddata_api_client/model/automation_metadata.py create mode 100644 gooddata-api-client/gooddata_api_client/model/content_slide_template.py create mode 100644 gooddata-api-client/gooddata_api_client/model/cover_slide_template.py create mode 100644 gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.py create mode 100644 gooddata-api-client/gooddata_api_client/model/declarative_export_template.py create mode 100644 gooddata-api-client/gooddata_api_client/model/declarative_export_templates.py create mode 100644 gooddata-api-client/gooddata_api_client/model/get_slides_export202_response_inner.py create mode 100644 gooddata-api-client/gooddata_api_client/model/intro_slide_template.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_metadata.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_out.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_with_links.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/running_section.py create mode 100644 gooddata-api-client/gooddata_api_client/model/section_slide_template.py create mode 100644 gooddata-api-client/gooddata_api_client/model/visible_filter.py create mode 100644 gooddata-api-client/gooddata_api_client/model/widget_slides_template.py diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index b92686023..851f0dccf 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -9,6 +9,7 @@ docs/AbstractMeasureValueFilter.md docs/ActionsApi.md docs/ActiveObjectIdentification.md docs/AdHocAutomation.md +docs/AfmCancelTokens.md docs/AfmExecution.md docs/AfmExecutionResponse.md docs/AfmIdentifier.md @@ -59,6 +60,7 @@ docs/AttributesApi.md docs/AutomationAlert.md docs/AutomationAlertCondition.md docs/AutomationExternalRecipient.md +docs/AutomationMetadata.md docs/AutomationNotification.md docs/AutomationNotificationAllOf.md docs/AutomationSchedule.md @@ -88,8 +90,10 @@ docs/ComparisonMeasureValueFilter.md docs/ComparisonMeasureValueFilterComparisonMeasureValueFilter.md docs/ComparisonWrapper.md docs/ComputationApi.md +docs/ContentSlideTemplate.md docs/ContextFiltersApi.md docs/CookieSecurityConfigurationApi.md +docs/CoverSlideTemplate.md docs/CreatedVisualization.md docs/CreatedVisualizationFiltersInner.md docs/CreatedVisualizations.md @@ -98,6 +102,7 @@ docs/CustomMetric.md docs/CustomOverride.md docs/DashboardPermissions.md docs/DashboardPermissionsAssignment.md +docs/DashboardSlidesTemplate.md docs/DashboardsApi.md docs/DataColumnLocator.md docs/DataColumnLocators.md @@ -147,6 +152,8 @@ docs/DeclarativeDateDataset.md docs/DeclarativeExportDefinition.md docs/DeclarativeExportDefinitionIdentifier.md docs/DeclarativeExportDefinitionRequestPayload.md +docs/DeclarativeExportTemplate.md +docs/DeclarativeExportTemplates.md docs/DeclarativeFact.md docs/DeclarativeFilterContext.md docs/DeclarativeFilterView.md @@ -245,6 +252,7 @@ docs/FrequencyBucket.md docs/FrequencyProperties.md docs/GenerateLdmRequest.md docs/GenerateLogicalDataModelApi.md +docs/GetSlidesExport202ResponseInner.md docs/GrainIdentifier.md docs/GrantedPermission.md docs/GranularitiesFormatting.md @@ -262,6 +270,7 @@ docs/InlineFilterDefinition.md docs/InlineFilterDefinitionInline.md docs/InlineMeasureDefinition.md docs/InlineMeasureDefinitionInline.md +docs/IntroSlideTemplate.md docs/InvalidateCacheApi.md docs/JWKSApi.md docs/JsonApiAnalyticalDashboardIn.md @@ -334,6 +343,7 @@ docs/JsonApiAutomationIn.md docs/JsonApiAutomationInAttributes.md docs/JsonApiAutomationInAttributesAlert.md docs/JsonApiAutomationInAttributesExternalRecipientsInner.md +docs/JsonApiAutomationInAttributesMetadata.md docs/JsonApiAutomationInAttributesSchedule.md docs/JsonApiAutomationInAttributesTabularExportsInner.md docs/JsonApiAutomationInAttributesVisualExportsInner.md @@ -468,6 +478,20 @@ docs/JsonApiExportDefinitionPatchDocument.md docs/JsonApiExportDefinitionPostOptionalId.md docs/JsonApiExportDefinitionPostOptionalIdDocument.md docs/JsonApiExportDefinitionToManyLinkage.md +docs/JsonApiExportTemplateIn.md +docs/JsonApiExportTemplateInAttributes.md +docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md +docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md +docs/JsonApiExportTemplateInDocument.md +docs/JsonApiExportTemplateOut.md +docs/JsonApiExportTemplateOutDocument.md +docs/JsonApiExportTemplateOutList.md +docs/JsonApiExportTemplateOutWithLinks.md +docs/JsonApiExportTemplatePatch.md +docs/JsonApiExportTemplatePatchAttributes.md +docs/JsonApiExportTemplatePatchDocument.md +docs/JsonApiExportTemplatePostOptionalId.md +docs/JsonApiExportTemplatePostOptionalIdDocument.md docs/JsonApiFactLinkage.md docs/JsonApiFactOut.md docs/JsonApiFactOutAttributes.md @@ -830,6 +854,7 @@ docs/ResultSpec.md docs/RouteResult.md docs/RsaSpecification.md docs/RulePermission.md +docs/RunningSection.md docs/ScanRequest.md docs/ScanResultPdm.md docs/ScanSqlRequest.md @@ -839,12 +864,13 @@ docs/SearchRelationshipObject.md docs/SearchRequest.md docs/SearchResult.md docs/SearchResultObject.md +docs/SectionSlideTemplate.md docs/Settings.md docs/SimpleMeasureDefinition.md docs/SimpleMeasureDefinitionMeasure.md docs/Skeleton.md +docs/SlidesExportApi.md docs/SlidesExportRequest.md -docs/SlideshowExportApi.md docs/SmartFunctionResponse.md docs/SmartFunctionsApi.md docs/Smtp.md @@ -908,6 +934,7 @@ docs/UsersDeclarativeAPIsApi.md docs/UsersEntityAPIsApi.md docs/ValidateByItem.md docs/Value.md +docs/VisibleFilter.md docs/VisualExportApi.md docs/VisualExportRequest.md docs/VisualizationObjectApi.md @@ -917,6 +944,7 @@ docs/WebhookAutomationInfo.md docs/WebhookMessage.md docs/WebhookMessageData.md docs/WebhookRecipient.md +docs/WidgetSlidesTemplate.md docs/WorkspaceDataSource.md docs/WorkspaceIdentifier.md docs/WorkspaceObjectControllerApi.md @@ -978,7 +1006,7 @@ gooddata_api_client/api/plugins_api.py gooddata_api_client/api/raw_export_api.py gooddata_api_client/api/reporting_settings_api.py gooddata_api_client/api/scanning_api.py -gooddata_api_client/api/slideshow_export_api.py +gooddata_api_client/api/slides_export_api.py gooddata_api_client/api/smart_functions_api.py gooddata_api_client/api/tabular_export_api.py gooddata_api_client/api/test_connection_api.py @@ -1011,6 +1039,7 @@ gooddata_api_client/model/abstract_measure_value_filter.py gooddata_api_client/model/active_object_identification.py gooddata_api_client/model/ad_hoc_automation.py gooddata_api_client/model/afm.py +gooddata_api_client/model/afm_cancel_tokens.py gooddata_api_client/model/afm_execution.py gooddata_api_client/model/afm_execution_response.py gooddata_api_client/model/afm_identifier.py @@ -1057,6 +1086,7 @@ gooddata_api_client/model/attribute_result_header.py gooddata_api_client/model/automation_alert.py gooddata_api_client/model/automation_alert_condition.py gooddata_api_client/model/automation_external_recipient.py +gooddata_api_client/model/automation_metadata.py gooddata_api_client/model/automation_notification.py gooddata_api_client/model/automation_notification_all_of.py gooddata_api_client/model/automation_schedule.py @@ -1082,6 +1112,8 @@ gooddata_api_client/model/comparison.py gooddata_api_client/model/comparison_measure_value_filter.py gooddata_api_client/model/comparison_measure_value_filter_comparison_measure_value_filter.py gooddata_api_client/model/comparison_wrapper.py +gooddata_api_client/model/content_slide_template.py +gooddata_api_client/model/cover_slide_template.py gooddata_api_client/model/created_visualization.py gooddata_api_client/model/created_visualization_filters_inner.py gooddata_api_client/model/created_visualizations.py @@ -1090,6 +1122,7 @@ gooddata_api_client/model/custom_metric.py gooddata_api_client/model/custom_override.py gooddata_api_client/model/dashboard_permissions.py gooddata_api_client/model/dashboard_permissions_assignment.py +gooddata_api_client/model/dashboard_slides_template.py gooddata_api_client/model/data_column_locator.py gooddata_api_client/model/data_column_locators.py gooddata_api_client/model/data_source_parameter.py @@ -1134,6 +1167,8 @@ gooddata_api_client/model/declarative_date_dataset.py gooddata_api_client/model/declarative_export_definition.py gooddata_api_client/model/declarative_export_definition_identifier.py gooddata_api_client/model/declarative_export_definition_request_payload.py +gooddata_api_client/model/declarative_export_template.py +gooddata_api_client/model/declarative_export_templates.py gooddata_api_client/model/declarative_fact.py gooddata_api_client/model/declarative_filter_context.py gooddata_api_client/model/declarative_filter_view.py @@ -1225,6 +1260,7 @@ 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_ldm_request.py +gooddata_api_client/model/get_slides_export202_response_inner.py gooddata_api_client/model/grain_identifier.py gooddata_api_client/model/granted_permission.py gooddata_api_client/model/granularities_formatting.py @@ -1240,6 +1276,7 @@ gooddata_api_client/model/inline_filter_definition.py gooddata_api_client/model/inline_filter_definition_inline.py gooddata_api_client/model/inline_measure_definition.py gooddata_api_client/model/inline_measure_definition_inline.py +gooddata_api_client/model/intro_slide_template.py gooddata_api_client/model/json_api_analytical_dashboard_in.py gooddata_api_client/model/json_api_analytical_dashboard_in_attributes.py gooddata_api_client/model/json_api_analytical_dashboard_in_document.py @@ -1310,6 +1347,7 @@ gooddata_api_client/model/json_api_automation_in.py gooddata_api_client/model/json_api_automation_in_attributes.py gooddata_api_client/model/json_api_automation_in_attributes_alert.py gooddata_api_client/model/json_api_automation_in_attributes_external_recipients_inner.py +gooddata_api_client/model/json_api_automation_in_attributes_metadata.py gooddata_api_client/model/json_api_automation_in_attributes_schedule.py gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py @@ -1444,6 +1482,20 @@ gooddata_api_client/model/json_api_export_definition_patch_document.py gooddata_api_client/model/json_api_export_definition_post_optional_id.py gooddata_api_client/model/json_api_export_definition_post_optional_id_document.py gooddata_api_client/model/json_api_export_definition_to_many_linkage.py +gooddata_api_client/model/json_api_export_template_in.py +gooddata_api_client/model/json_api_export_template_in_attributes.py +gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py +gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py +gooddata_api_client/model/json_api_export_template_in_document.py +gooddata_api_client/model/json_api_export_template_out.py +gooddata_api_client/model/json_api_export_template_out_document.py +gooddata_api_client/model/json_api_export_template_out_list.py +gooddata_api_client/model/json_api_export_template_out_with_links.py +gooddata_api_client/model/json_api_export_template_patch.py +gooddata_api_client/model/json_api_export_template_patch_attributes.py +gooddata_api_client/model/json_api_export_template_patch_document.py +gooddata_api_client/model/json_api_export_template_post_optional_id.py +gooddata_api_client/model/json_api_export_template_post_optional_id_document.py gooddata_api_client/model/json_api_fact_linkage.py gooddata_api_client/model/json_api_fact_out.py gooddata_api_client/model/json_api_fact_out_attributes.py @@ -1789,6 +1841,7 @@ 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/running_section.py gooddata_api_client/model/scan_request.py gooddata_api_client/model/scan_result_pdm.py gooddata_api_client/model/scan_sql_request.py @@ -1797,6 +1850,7 @@ gooddata_api_client/model/search_relationship_object.py gooddata_api_client/model/search_request.py gooddata_api_client/model/search_result.py gooddata_api_client/model/search_result_object.py +gooddata_api_client/model/section_slide_template.py gooddata_api_client/model/settings.py gooddata_api_client/model/simple_measure_definition.py gooddata_api_client/model/simple_measure_definition_measure.py @@ -1850,6 +1904,7 @@ gooddata_api_client/model/user_management_workspace_permission_assignment.py gooddata_api_client/model/user_permission.py gooddata_api_client/model/validate_by_item.py gooddata_api_client/model/value.py +gooddata_api_client/model/visible_filter.py gooddata_api_client/model/visual_export_request.py gooddata_api_client/model/webhook.py gooddata_api_client/model/webhook_all_of.py @@ -1857,6 +1912,7 @@ 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/widget_slides_template.py gooddata_api_client/model/workspace_data_source.py gooddata_api_client/model/workspace_identifier.py gooddata_api_client/model/workspace_permission_assignment.py diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index 3e6844aa3..f859e25d7 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -245,11 +245,13 @@ Class | Method | HTTP request | Description *NotificationChannelsApi* | [**delete_entity_notification_channels**](docs/NotificationChannelsApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity *NotificationChannelsApi* | [**get_all_entities_notification_channels**](docs/NotificationChannelsApi.md#get_all_entities_notification_channels) | **GET** /api/v1/entities/notificationChannels | Get all Notification Channel entities *NotificationChannelsApi* | [**get_entity_notification_channels**](docs/NotificationChannelsApi.md#get_entity_notification_channels) | **GET** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity +*NotificationChannelsApi* | [**get_export_templates_layout**](docs/NotificationChannelsApi.md#get_export_templates_layout) | **GET** /api/v1/layout/exportTemplates | Get all export templates layout *NotificationChannelsApi* | [**get_notification_channels_layout**](docs/NotificationChannelsApi.md#get_notification_channels_layout) | **GET** /api/v1/layout/notificationChannels | Get all notification channels layout *NotificationChannelsApi* | [**get_notifications**](docs/NotificationChannelsApi.md#get_notifications) | **GET** /api/v1/actions/notifications | Get latest notifications. *NotificationChannelsApi* | [**mark_as_read_notification**](docs/NotificationChannelsApi.md#mark_as_read_notification) | **POST** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read. *NotificationChannelsApi* | [**mark_as_read_notification_all**](docs/NotificationChannelsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. *NotificationChannelsApi* | [**patch_entity_notification_channels**](docs/NotificationChannelsApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity +*NotificationChannelsApi* | [**set_export_templates**](docs/NotificationChannelsApi.md#set_export_templates) | **PUT** /api/v1/layout/exportTemplates | Set all export templates *NotificationChannelsApi* | [**set_notification_channels**](docs/NotificationChannelsApi.md#set_notification_channels) | **PUT** /api/v1/layout/notificationChannels | Set all notification channels *NotificationChannelsApi* | [**test_existing_notification_channel**](docs/NotificationChannelsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel. *NotificationChannelsApi* | [**test_notification_channel**](docs/NotificationChannelsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel. @@ -294,9 +296,9 @@ Class | Method | HTTP request | Description *ScanningApi* | [**get_data_source_schemata**](docs/ScanningApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database *ScanningApi* | [**scan_data_source**](docs/ScanningApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM) *ScanningApi* | [**scan_sql**](docs/ScanningApi.md#scan_sql) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanSql | Collect metadata about SQL query -*SlideshowExportApi* | [**create_slides_export**](docs/SlideshowExportApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request -*SlideshowExportApi* | [**get_slides_export**](docs/SlideshowExportApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files -*SlideshowExportApi* | [**get_slides_export_metadata**](docs/SlideshowExportApi.md#get_slides_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context +*SlidesExportApi* | [**create_slides_export**](docs/SlidesExportApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request +*SlidesExportApi* | [**get_slides_export**](docs/SlidesExportApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files +*SlidesExportApi* | [**get_slides_export_metadata**](docs/SlidesExportApi.md#get_slides_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context *SmartFunctionsApi* | [**ai_chat**](docs/SmartFunctionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (BETA) Chat with AI *SmartFunctionsApi* | [**ai_chat_history**](docs/SmartFunctionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (BETA) Get Chat History *SmartFunctionsApi* | [**ai_chat_stream**](docs/SmartFunctionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (BETA) Chat with AI @@ -401,6 +403,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**anomaly_detection**](docs/ActionsApi.md#anomaly_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection *ActionsApi* | [**anomaly_detection_result**](docs/ActionsApi.md#anomaly_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection Result *ActionsApi* | [**available_assignees**](docs/ActionsApi.md#available_assignees) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees | Get Available Assignees +*ActionsApi* | [**cancel_executions**](docs/ActionsApi.md#cancel_executions) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel | Applies all the given cancel tokens. *ActionsApi* | [**check_entity_overrides**](docs/ActionsApi.md#check_entity_overrides) | **POST** /api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides | Finds entities with given ID in hierarchy. *ActionsApi* | [**clean_translations**](docs/ActionsApi.md#clean_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/clean | Cleans up translations. *ActionsApi* | [**clustering**](docs/ActionsApi.md#clustering) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId} | (EXPERIMENTAL) Smart functions - Clustering @@ -479,6 +482,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**create_entity_dashboard_plugins**](docs/EntitiesApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins *EntitiesApi* | [**create_entity_data_sources**](docs/EntitiesApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources *EntitiesApi* | [**create_entity_export_definitions**](docs/EntitiesApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions +*EntitiesApi* | [**create_entity_export_templates**](docs/EntitiesApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities *EntitiesApi* | [**create_entity_filter_contexts**](docs/EntitiesApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Context Filters *EntitiesApi* | [**create_entity_filter_views**](docs/EntitiesApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views *EntitiesApi* | [**create_entity_identity_providers**](docs/EntitiesApi.md#create_entity_identity_providers) | **POST** /api/v1/entities/identityProviders | Post Identity Providers @@ -507,6 +511,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_dashboard_plugins**](docs/EntitiesApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin *EntitiesApi* | [**delete_entity_data_sources**](docs/EntitiesApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity *EntitiesApi* | [**delete_entity_export_definitions**](docs/EntitiesApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition +*EntitiesApi* | [**delete_entity_export_templates**](docs/EntitiesApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity *EntitiesApi* | [**delete_entity_filter_contexts**](docs/EntitiesApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Context Filter *EntitiesApi* | [**delete_entity_filter_views**](docs/EntitiesApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view *EntitiesApi* | [**delete_entity_identity_providers**](docs/EntitiesApi.md#delete_entity_identity_providers) | **DELETE** /api/v1/entities/identityProviders/{id} | Delete Identity Provider @@ -539,6 +544,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_datasets**](docs/EntitiesApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets *EntitiesApi* | [**get_all_entities_entitlements**](docs/EntitiesApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements *EntitiesApi* | [**get_all_entities_export_definitions**](docs/EntitiesApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions +*EntitiesApi* | [**get_all_entities_export_templates**](docs/EntitiesApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities *EntitiesApi* | [**get_all_entities_facts**](docs/EntitiesApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts *EntitiesApi* | [**get_all_entities_filter_contexts**](docs/EntitiesApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Context Filters *EntitiesApi* | [**get_all_entities_filter_views**](docs/EntitiesApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views @@ -577,6 +583,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_datasets**](docs/EntitiesApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset *EntitiesApi* | [**get_entity_entitlements**](docs/EntitiesApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement *EntitiesApi* | [**get_entity_export_definitions**](docs/EntitiesApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition +*EntitiesApi* | [**get_entity_export_templates**](docs/EntitiesApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity *EntitiesApi* | [**get_entity_facts**](docs/EntitiesApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact *EntitiesApi* | [**get_entity_filter_contexts**](docs/EntitiesApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Context Filter *EntitiesApi* | [**get_entity_filter_views**](docs/EntitiesApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view @@ -610,6 +617,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_dashboard_plugins**](docs/EntitiesApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin *EntitiesApi* | [**patch_entity_data_sources**](docs/EntitiesApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity *EntitiesApi* | [**patch_entity_export_definitions**](docs/EntitiesApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition +*EntitiesApi* | [**patch_entity_export_templates**](docs/EntitiesApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity *EntitiesApi* | [**patch_entity_filter_contexts**](docs/EntitiesApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Context Filter *EntitiesApi* | [**patch_entity_filter_views**](docs/EntitiesApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view *EntitiesApi* | [**patch_entity_identity_providers**](docs/EntitiesApi.md#patch_entity_identity_providers) | **PATCH** /api/v1/entities/identityProviders/{id} | Patch Identity Provider @@ -638,6 +646,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_dashboard_plugins**](docs/EntitiesApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin *EntitiesApi* | [**update_entity_data_sources**](docs/EntitiesApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity *EntitiesApi* | [**update_entity_export_definitions**](docs/EntitiesApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition +*EntitiesApi* | [**update_entity_export_templates**](docs/EntitiesApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity *EntitiesApi* | [**update_entity_filter_contexts**](docs/EntitiesApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Context Filter *EntitiesApi* | [**update_entity_filter_views**](docs/EntitiesApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views *EntitiesApi* | [**update_entity_identity_providers**](docs/EntitiesApi.md#update_entity_identity_providers) | **PUT** /api/v1/entities/identityProviders/{id} | Put Identity Provider @@ -661,6 +670,7 @@ Class | Method | HTTP request | Description *LayoutApi* | [**get_automations**](docs/LayoutApi.md#get_automations) | **GET** /api/v1/layout/workspaces/{workspaceId}/automations | Get automations *LayoutApi* | [**get_data_source_permissions**](docs/LayoutApi.md#get_data_source_permissions) | **GET** /api/v1/layout/dataSources/{dataSourceId}/permissions | Get permissions for the data source *LayoutApi* | [**get_data_sources_layout**](docs/LayoutApi.md#get_data_sources_layout) | **GET** /api/v1/layout/dataSources | Get all data sources +*LayoutApi* | [**get_export_templates_layout**](docs/LayoutApi.md#get_export_templates_layout) | **GET** /api/v1/layout/exportTemplates | Get all export templates layout *LayoutApi* | [**get_filter_views**](docs/LayoutApi.md#get_filter_views) | **GET** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views *LayoutApi* | [**get_identity_providers_layout**](docs/LayoutApi.md#get_identity_providers_layout) | **GET** /api/v1/layout/identityProviders | Get all identity providers layout *LayoutApi* | [**get_logical_model**](docs/LayoutApi.md#get_logical_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Get logical model @@ -685,6 +695,7 @@ Class | Method | HTTP request | Description *LayoutApi* | [**set_analytics_model**](docs/LayoutApi.md#set_analytics_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Set analytics model *LayoutApi* | [**set_automations**](docs/LayoutApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations *LayoutApi* | [**set_data_source_permissions**](docs/LayoutApi.md#set_data_source_permissions) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/permissions | Set data source permissions. +*LayoutApi* | [**set_export_templates**](docs/LayoutApi.md#set_export_templates) | **PUT** /api/v1/layout/exportTemplates | Set all export templates *LayoutApi* | [**set_filter_views**](docs/LayoutApi.md#set_filter_views) | **PUT** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views *LayoutApi* | [**set_identity_providers**](docs/LayoutApi.md#set_identity_providers) | **PUT** /api/v1/layout/identityProviders | Set all identity providers *LayoutApi* | [**set_logical_model**](docs/LayoutApi.md#set_logical_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Set logical model @@ -706,6 +717,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**create_entity_color_palettes**](docs/OrganizationModelControllerApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes *OrganizationModelControllerApi* | [**create_entity_csp_directives**](docs/OrganizationModelControllerApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives *OrganizationModelControllerApi* | [**create_entity_data_sources**](docs/OrganizationModelControllerApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources +*OrganizationModelControllerApi* | [**create_entity_export_templates**](docs/OrganizationModelControllerApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities *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 @@ -718,6 +730,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**delete_entity_color_palettes**](docs/OrganizationModelControllerApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette *OrganizationModelControllerApi* | [**delete_entity_csp_directives**](docs/OrganizationModelControllerApi.md#delete_entity_csp_directives) | **DELETE** /api/v1/entities/cspDirectives/{id} | Delete CSP Directives *OrganizationModelControllerApi* | [**delete_entity_data_sources**](docs/OrganizationModelControllerApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity +*OrganizationModelControllerApi* | [**delete_entity_export_templates**](docs/OrganizationModelControllerApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity *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} | @@ -732,6 +745,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**get_all_entities_data_source_identifiers**](docs/OrganizationModelControllerApi.md#get_all_entities_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers *OrganizationModelControllerApi* | [**get_all_entities_data_sources**](docs/OrganizationModelControllerApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities *OrganizationModelControllerApi* | [**get_all_entities_entitlements**](docs/OrganizationModelControllerApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements +*OrganizationModelControllerApi* | [**get_all_entities_export_templates**](docs/OrganizationModelControllerApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities *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 @@ -747,6 +761,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**get_entity_data_source_identifiers**](docs/OrganizationModelControllerApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier *OrganizationModelControllerApi* | [**get_entity_data_sources**](docs/OrganizationModelControllerApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity *OrganizationModelControllerApi* | [**get_entity_entitlements**](docs/OrganizationModelControllerApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement +*OrganizationModelControllerApi* | [**get_entity_export_templates**](docs/OrganizationModelControllerApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity *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 @@ -760,6 +775,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**patch_entity_color_palettes**](docs/OrganizationModelControllerApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette *OrganizationModelControllerApi* | [**patch_entity_csp_directives**](docs/OrganizationModelControllerApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives *OrganizationModelControllerApi* | [**patch_entity_data_sources**](docs/OrganizationModelControllerApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity +*OrganizationModelControllerApi* | [**patch_entity_export_templates**](docs/OrganizationModelControllerApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity *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 @@ -772,6 +788,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**update_entity_color_palettes**](docs/OrganizationModelControllerApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette *OrganizationModelControllerApi* | [**update_entity_csp_directives**](docs/OrganizationModelControllerApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives *OrganizationModelControllerApi* | [**update_entity_data_sources**](docs/OrganizationModelControllerApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity +*OrganizationModelControllerApi* | [**update_entity_export_templates**](docs/OrganizationModelControllerApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity *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 @@ -892,6 +909,7 @@ Class | Method | HTTP request | Description - [AbstractMeasureValueFilter](docs/AbstractMeasureValueFilter.md) - [ActiveObjectIdentification](docs/ActiveObjectIdentification.md) - [AdHocAutomation](docs/AdHocAutomation.md) + - [AfmCancelTokens](docs/AfmCancelTokens.md) - [AfmExecution](docs/AfmExecution.md) - [AfmExecutionResponse](docs/AfmExecutionResponse.md) - [AfmIdentifier](docs/AfmIdentifier.md) @@ -938,6 +956,7 @@ Class | Method | HTTP request | Description - [AutomationAlert](docs/AutomationAlert.md) - [AutomationAlertCondition](docs/AutomationAlertCondition.md) - [AutomationExternalRecipient](docs/AutomationExternalRecipient.md) + - [AutomationMetadata](docs/AutomationMetadata.md) - [AutomationNotification](docs/AutomationNotification.md) - [AutomationNotificationAllOf](docs/AutomationNotificationAllOf.md) - [AutomationSchedule](docs/AutomationSchedule.md) @@ -963,6 +982,8 @@ Class | Method | HTTP request | Description - [ComparisonMeasureValueFilter](docs/ComparisonMeasureValueFilter.md) - [ComparisonMeasureValueFilterComparisonMeasureValueFilter](docs/ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) - [ComparisonWrapper](docs/ComparisonWrapper.md) + - [ContentSlideTemplate](docs/ContentSlideTemplate.md) + - [CoverSlideTemplate](docs/CoverSlideTemplate.md) - [CreatedVisualization](docs/CreatedVisualization.md) - [CreatedVisualizationFiltersInner](docs/CreatedVisualizationFiltersInner.md) - [CreatedVisualizations](docs/CreatedVisualizations.md) @@ -971,6 +992,7 @@ Class | Method | HTTP request | Description - [CustomOverride](docs/CustomOverride.md) - [DashboardPermissions](docs/DashboardPermissions.md) - [DashboardPermissionsAssignment](docs/DashboardPermissionsAssignment.md) + - [DashboardSlidesTemplate](docs/DashboardSlidesTemplate.md) - [DataColumnLocator](docs/DataColumnLocator.md) - [DataColumnLocators](docs/DataColumnLocators.md) - [DataSourceParameter](docs/DataSourceParameter.md) @@ -1015,6 +1037,8 @@ Class | Method | HTTP request | Description - [DeclarativeExportDefinition](docs/DeclarativeExportDefinition.md) - [DeclarativeExportDefinitionIdentifier](docs/DeclarativeExportDefinitionIdentifier.md) - [DeclarativeExportDefinitionRequestPayload](docs/DeclarativeExportDefinitionRequestPayload.md) + - [DeclarativeExportTemplate](docs/DeclarativeExportTemplate.md) + - [DeclarativeExportTemplates](docs/DeclarativeExportTemplates.md) - [DeclarativeFact](docs/DeclarativeFact.md) - [DeclarativeFilterContext](docs/DeclarativeFilterContext.md) - [DeclarativeFilterView](docs/DeclarativeFilterView.md) @@ -1106,6 +1130,7 @@ Class | Method | HTTP request | Description - [FrequencyBucket](docs/FrequencyBucket.md) - [FrequencyProperties](docs/FrequencyProperties.md) - [GenerateLdmRequest](docs/GenerateLdmRequest.md) + - [GetSlidesExport202ResponseInner](docs/GetSlidesExport202ResponseInner.md) - [GrainIdentifier](docs/GrainIdentifier.md) - [GrantedPermission](docs/GrantedPermission.md) - [GranularitiesFormatting](docs/GranularitiesFormatting.md) @@ -1121,6 +1146,7 @@ Class | Method | HTTP request | Description - [InlineFilterDefinitionInline](docs/InlineFilterDefinitionInline.md) - [InlineMeasureDefinition](docs/InlineMeasureDefinition.md) - [InlineMeasureDefinitionInline](docs/InlineMeasureDefinitionInline.md) + - [IntroSlideTemplate](docs/IntroSlideTemplate.md) - [JsonApiAnalyticalDashboardIn](docs/JsonApiAnalyticalDashboardIn.md) - [JsonApiAnalyticalDashboardInAttributes](docs/JsonApiAnalyticalDashboardInAttributes.md) - [JsonApiAnalyticalDashboardInDocument](docs/JsonApiAnalyticalDashboardInDocument.md) @@ -1191,6 +1217,7 @@ Class | Method | HTTP request | Description - [JsonApiAutomationInAttributes](docs/JsonApiAutomationInAttributes.md) - [JsonApiAutomationInAttributesAlert](docs/JsonApiAutomationInAttributesAlert.md) - [JsonApiAutomationInAttributesExternalRecipientsInner](docs/JsonApiAutomationInAttributesExternalRecipientsInner.md) + - [JsonApiAutomationInAttributesMetadata](docs/JsonApiAutomationInAttributesMetadata.md) - [JsonApiAutomationInAttributesSchedule](docs/JsonApiAutomationInAttributesSchedule.md) - [JsonApiAutomationInAttributesTabularExportsInner](docs/JsonApiAutomationInAttributesTabularExportsInner.md) - [JsonApiAutomationInAttributesVisualExportsInner](docs/JsonApiAutomationInAttributesVisualExportsInner.md) @@ -1325,6 +1352,20 @@ Class | Method | HTTP request | Description - [JsonApiExportDefinitionPostOptionalId](docs/JsonApiExportDefinitionPostOptionalId.md) - [JsonApiExportDefinitionPostOptionalIdDocument](docs/JsonApiExportDefinitionPostOptionalIdDocument.md) - [JsonApiExportDefinitionToManyLinkage](docs/JsonApiExportDefinitionToManyLinkage.md) + - [JsonApiExportTemplateIn](docs/JsonApiExportTemplateIn.md) + - [JsonApiExportTemplateInAttributes](docs/JsonApiExportTemplateInAttributes.md) + - [JsonApiExportTemplateInAttributesDashboardSlidesTemplate](docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md) + - [JsonApiExportTemplateInAttributesWidgetSlidesTemplate](docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md) + - [JsonApiExportTemplateInDocument](docs/JsonApiExportTemplateInDocument.md) + - [JsonApiExportTemplateOut](docs/JsonApiExportTemplateOut.md) + - [JsonApiExportTemplateOutDocument](docs/JsonApiExportTemplateOutDocument.md) + - [JsonApiExportTemplateOutList](docs/JsonApiExportTemplateOutList.md) + - [JsonApiExportTemplateOutWithLinks](docs/JsonApiExportTemplateOutWithLinks.md) + - [JsonApiExportTemplatePatch](docs/JsonApiExportTemplatePatch.md) + - [JsonApiExportTemplatePatchAttributes](docs/JsonApiExportTemplatePatchAttributes.md) + - [JsonApiExportTemplatePatchDocument](docs/JsonApiExportTemplatePatchDocument.md) + - [JsonApiExportTemplatePostOptionalId](docs/JsonApiExportTemplatePostOptionalId.md) + - [JsonApiExportTemplatePostOptionalIdDocument](docs/JsonApiExportTemplatePostOptionalIdDocument.md) - [JsonApiFactLinkage](docs/JsonApiFactLinkage.md) - [JsonApiFactOut](docs/JsonApiFactOut.md) - [JsonApiFactOutAttributes](docs/JsonApiFactOutAttributes.md) @@ -1670,6 +1711,7 @@ Class | Method | HTTP request | Description - [RouteResult](docs/RouteResult.md) - [RsaSpecification](docs/RsaSpecification.md) - [RulePermission](docs/RulePermission.md) + - [RunningSection](docs/RunningSection.md) - [ScanRequest](docs/ScanRequest.md) - [ScanResultPdm](docs/ScanResultPdm.md) - [ScanSqlRequest](docs/ScanSqlRequest.md) @@ -1678,6 +1720,7 @@ Class | Method | HTTP request | Description - [SearchRequest](docs/SearchRequest.md) - [SearchResult](docs/SearchResult.md) - [SearchResultObject](docs/SearchResultObject.md) + - [SectionSlideTemplate](docs/SectionSlideTemplate.md) - [Settings](docs/Settings.md) - [SimpleMeasureDefinition](docs/SimpleMeasureDefinition.md) - [SimpleMeasureDefinitionMeasure](docs/SimpleMeasureDefinitionMeasure.md) @@ -1731,6 +1774,7 @@ Class | Method | HTTP request | Description - [UserPermission](docs/UserPermission.md) - [ValidateByItem](docs/ValidateByItem.md) - [Value](docs/Value.md) + - [VisibleFilter](docs/VisibleFilter.md) - [VisualExportRequest](docs/VisualExportRequest.md) - [Webhook](docs/Webhook.md) - [WebhookAllOf](docs/WebhookAllOf.md) @@ -1738,6 +1782,7 @@ Class | Method | HTTP request | Description - [WebhookMessage](docs/WebhookMessage.md) - [WebhookMessageData](docs/WebhookMessageData.md) - [WebhookRecipient](docs/WebhookRecipient.md) + - [WidgetSlidesTemplate](docs/WidgetSlidesTemplate.md) - [WorkspaceDataSource](docs/WorkspaceDataSource.md) - [WorkspaceIdentifier](docs/WorkspaceIdentifier.md) - [WorkspacePermissionAssignment](docs/WorkspacePermissionAssignment.md) diff --git a/gooddata-api-client/docs/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index 54f33c224..9b6527408 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -12,6 +12,7 @@ Method | HTTP request | Description [**anomaly_detection**](ActionsApi.md#anomaly_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection [**anomaly_detection_result**](ActionsApi.md#anomaly_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection Result [**available_assignees**](ActionsApi.md#available_assignees) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees | Get Available Assignees +[**cancel_executions**](ActionsApi.md#cancel_executions) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel | Applies all the given cancel tokens. [**check_entity_overrides**](ActionsApi.md#check_entity_overrides) | **POST** /api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides | Finds entities with given ID in hierarchy. [**clean_translations**](ActionsApi.md#clean_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/clean | Cleans up translations. [**clustering**](ActionsApi.md#clustering) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId} | (EXPERIMENTAL) Smart functions - Clustering @@ -704,6 +705,79 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **cancel_executions** +> AfmCancelTokens cancel_executions(workspace_id, afm_cancel_tokens) + +Applies all the given cancel tokens. + +Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is canceled. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + afm_cancel_tokens = AfmCancelTokens( + token_ids=[ + "token_ids_example", + ], + ) # AfmCancelTokens | + + # example passing only required values which don't have defaults set + try: + # Applies all the given cancel tokens. + api_response = api_instance.cancel_executions(workspace_id, afm_cancel_tokens) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->cancel_executions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **afm_cancel_tokens** | [**AfmCancelTokens**](AfmCancelTokens.md)| | + +### Return type + +[**AfmCancelTokens**](AfmCancelTokens.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Status of the cancelling operation. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **check_entity_overrides** > [IdentifierDuplications] check_entity_overrides(workspace_id, hierarchy_object_identification) @@ -1292,6 +1366,7 @@ with gooddata_api_client.ApiClient() as api_client: ), settings=ExecutionSettings( data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), ), ) # AfmExecution | skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False @@ -1343,7 +1418,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | AFM Execution response with links to the result and server-enhanced dimensions from the original request. | - | +**200** | AFM Execution response with links to the result and server-enhanced dimensions from the original request. | * X-GDC-CANCEL-TOKEN - A token that can be used to cancel this execution
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1745,6 +1820,7 @@ with gooddata_api_client.ApiClient() as api_client: ), execution_settings=ExecutionSettings( data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), ), file_name="result", format="CSV", @@ -1823,6 +1899,10 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PDF", metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example", + ], widget_ids=[ "widget_ids_example", ], @@ -2129,6 +2209,7 @@ with gooddata_api_client.ApiClient() as api_client: ), settings=ExecutionSettings( data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), ), ) # AfmExecution | explain_type = "MAQL" # str | Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `SETTINGS` - Settings used to execute explain request (optional) @@ -2986,6 +3067,7 @@ Note: This API is an experimental and is going to change. Please, use it accordi import time import gooddata_api_client from gooddata_api_client.api import actions_api +from gooddata_api_client.model.get_slides_export202_response_inner import GetSlidesExport202ResponseInner from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4846,6 +4928,7 @@ with gooddata_api_client.ApiClient() as api_client: excluded_total_dimensions = [ "excludedTotalDimensions=dim_0,dim_1", ] # [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 = "X-GDC-CANCEL-TOKEN_example" # str | (optional) # example passing only required values which don't have defaults set try: @@ -4859,7 +4942,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # Get a single execution result - api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions) + api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions, x_gdc_cancel_token=x_gdc_cancel_token) pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->retrieve_result: %s\n" % e) @@ -4875,6 +4958,7 @@ Name | Type | Description | Notes **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 type @@ -5600,7 +5684,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata=JsonNode(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), notification_channel=DeclarativeNotificationChannelIdentifier( id="webhook123", type="notificationChannel", diff --git a/gooddata-api-client/docs/AdHocAutomation.md b/gooddata-api-client/docs/AdHocAutomation.md index 871b51cee..880ff13ee 100644 --- a/gooddata-api-client/docs/AdHocAutomation.md +++ b/gooddata-api-client/docs/AdHocAutomation.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **description** | **str** | | [optional] **details** | **{str: (str,)}** | Additional details to be included in the automated message. | [optional] **external_recipients** | [**[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the automation action results. | [optional] -**metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**metadata** | [**AutomationMetadata**](AutomationMetadata.md) | | [optional] **notification_channel** | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | | [optional] **recipients** | [**[DeclarativeUserIdentifier]**](DeclarativeUserIdentifier.md) | | [optional] **tabular_exports** | [**[AutomationTabularExport]**](AutomationTabularExport.md) | | [optional] diff --git a/gooddata-api-client/docs/AfmCancelTokens.md b/gooddata-api-client/docs/AfmCancelTokens.md new file mode 100644 index 000000000..8a28fc7c7 --- /dev/null +++ b/gooddata-api-client/docs/AfmCancelTokens.md @@ -0,0 +1,13 @@ +# AfmCancelTokens + +Any information related to cancellation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token_ids** | **[str]** | Token ids to be used in the cancellation. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AutomationMetadata.md b/gooddata-api-client/docs/AutomationMetadata.md new file mode 100644 index 000000000..9f4c599c5 --- /dev/null +++ b/gooddata-api-client/docs/AutomationMetadata.md @@ -0,0 +1,14 @@ +# AutomationMetadata + +Additional information for the automation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visible_filters** | [**[VisibleFilter]**](VisibleFilter.md) | | [optional] +**widget** | **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/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index 2d103536b..f9404f7f7 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -87,7 +87,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), @@ -650,7 +658,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), @@ -889,7 +905,15 @@ with gooddata_api_client.ApiClient() as api_client: ), ], id="/6bUUGjjNSwg0_bs", - metadata=JsonNode(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -1054,7 +1078,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata=JsonNode(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), notification_channel=DeclarativeNotificationChannelIdentifier( id="webhook123", type="notificationChannel", @@ -1302,7 +1334,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), diff --git a/gooddata-api-client/docs/ComputationApi.md b/gooddata-api-client/docs/ComputationApi.md index 68a1854bb..418183d50 100644 --- a/gooddata-api-client/docs/ComputationApi.md +++ b/gooddata-api-client/docs/ComputationApi.md @@ -208,6 +208,7 @@ with gooddata_api_client.ApiClient() as api_client: ), settings=ExecutionSettings( data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), ), ) # AfmExecution | skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False @@ -259,7 +260,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | AFM Execution response with links to the result and server-enhanced dimensions from the original request. | - | +**200** | AFM Execution response with links to the result and server-enhanced dimensions from the original request. | * X-GDC-CANCEL-TOKEN - A token that can be used to cancel this execution
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -529,6 +530,7 @@ with gooddata_api_client.ApiClient() as api_client: ), settings=ExecutionSettings( data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), ), ) # AfmExecution | explain_type = "MAQL" # str | Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `SETTINGS` - Settings used to execute explain request (optional) @@ -862,6 +864,7 @@ with gooddata_api_client.ApiClient() as api_client: excluded_total_dimensions = [ "excludedTotalDimensions=dim_0,dim_1", ] # [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 = "X-GDC-CANCEL-TOKEN_example" # str | (optional) # example passing only required values which don't have defaults set try: @@ -875,7 +878,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # Get a single execution result - api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions) + api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions, x_gdc_cancel_token=x_gdc_cancel_token) pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ComputationApi->retrieve_result: %s\n" % e) @@ -891,6 +894,7 @@ Name | Type | Description | Notes **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 type diff --git a/gooddata-api-client/docs/ContentSlideTemplate.md b/gooddata-api-client/docs/ContentSlideTemplate.md new file mode 100644 index 000000000..4907ec8bc --- /dev/null +++ b/gooddata-api-client/docs/ContentSlideTemplate.md @@ -0,0 +1,15 @@ +# ContentSlideTemplate + +Settings for content slide. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description_field** | **str, none_type** | | [optional] +**footer** | [**RunningSection**](RunningSection.md) | | [optional] +**header** | [**RunningSection**](RunningSection.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/CoverSlideTemplate.md b/gooddata-api-client/docs/CoverSlideTemplate.md new file mode 100644 index 000000000..c2814bec1 --- /dev/null +++ b/gooddata-api-client/docs/CoverSlideTemplate.md @@ -0,0 +1,16 @@ +# CoverSlideTemplate + +Settings for cover slide. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_image** | **bool** | Show background image on the slide. | [optional] if omitted the server will use the default value of True +**description_field** | **str, none_type** | | [optional] +**footer** | [**RunningSection**](RunningSection.md) | | [optional] +**header** | [**RunningSection**](RunningSection.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/DashboardSlidesTemplate.md b/gooddata-api-client/docs/DashboardSlidesTemplate.md new file mode 100644 index 000000000..70ef4b2a6 --- /dev/null +++ b/gooddata-api-client/docs/DashboardSlidesTemplate.md @@ -0,0 +1,17 @@ +# DashboardSlidesTemplate + +Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applied_on** | **[str]** | Export types this template applies to. | +**content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**cover_slide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**intro_slide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**section_slide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/DeclarativeAutomation.md b/gooddata-api-client/docs/DeclarativeAutomation.md index ebfd1063d..b9483974f 100644 --- a/gooddata-api-client/docs/DeclarativeAutomation.md +++ b/gooddata-api-client/docs/DeclarativeAutomation.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **details** | **{str: (str,)}** | TODO | [optional] **export_definitions** | [**[DeclarativeExportDefinitionIdentifier]**](DeclarativeExportDefinitionIdentifier.md) | | [optional] **external_recipients** | [**[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the automation action results. | [optional] -**metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**metadata** | [**AutomationMetadata**](AutomationMetadata.md) | | [optional] **modified_at** | **str, none_type** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **notification_channel** | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | | [optional] diff --git a/gooddata-api-client/docs/DeclarativeExportTemplate.md b/gooddata-api-client/docs/DeclarativeExportTemplate.md new file mode 100644 index 000000000..4d126327d --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeExportTemplate.md @@ -0,0 +1,16 @@ +# DeclarativeExportTemplate + +A declarative form of a particular export template. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of an export template | +**name** | **str** | Name of an export template. | +**dashboard_slides_template** | [**DashboardSlidesTemplate**](DashboardSlidesTemplate.md) | | [optional] +**widget_slides_template** | [**WidgetSlidesTemplate**](WidgetSlidesTemplate.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/DeclarativeExportTemplates.md b/gooddata-api-client/docs/DeclarativeExportTemplates.md new file mode 100644 index 000000000..fe4338ea7 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeExportTemplates.md @@ -0,0 +1,13 @@ +# DeclarativeExportTemplates + +Export templates. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**export_templates** | [**[DeclarativeExportTemplate]**](DeclarativeExportTemplate.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/DeclarativeOrganization.md b/gooddata-api-client/docs/DeclarativeOrganization.md index e8fd27f9f..4b3f63852 100644 --- a/gooddata-api-client/docs/DeclarativeOrganization.md +++ b/gooddata-api-client/docs/DeclarativeOrganization.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **organization** | [**DeclarativeOrganizationInfo**](DeclarativeOrganizationInfo.md) | | **data_sources** | [**[DeclarativeDataSource]**](DeclarativeDataSource.md) | | [optional] +**export_templates** | [**[DeclarativeExportTemplate]**](DeclarativeExportTemplate.md) | | [optional] **identity_providers** | [**[DeclarativeIdentityProvider]**](DeclarativeIdentityProvider.md) | | [optional] **jwks** | [**[DeclarativeJwk]**](DeclarativeJwk.md) | | [optional] **notification_channels** | [**[DeclarativeNotificationChannel]**](DeclarativeNotificationChannel.md) | | [optional] diff --git a/gooddata-api-client/docs/DeclarativeOrganizationInfo.md b/gooddata-api-client/docs/DeclarativeOrganizationInfo.md index 18d4e679f..5ae584f1c 100644 --- a/gooddata-api-client/docs/DeclarativeOrganizationInfo.md +++ b/gooddata-api-client/docs/DeclarativeOrganizationInfo.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **oauth_client_id** | **str** | Identifier of the authentication provider | [optional] **oauth_client_secret** | **str** | Communication secret of the authentication provider (never returned back). | [optional] **oauth_custom_auth_attributes** | **{str: (str,)}** | 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] +**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **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] **oauth_issuer_location** | **str** | URI of the authentication provider. | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] diff --git a/gooddata-api-client/docs/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index f2048ddbc..121a49bcb 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -14,6 +14,7 @@ Method | HTTP request | Description [**create_entity_dashboard_plugins**](EntitiesApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins [**create_entity_data_sources**](EntitiesApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources [**create_entity_export_definitions**](EntitiesApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions +[**create_entity_export_templates**](EntitiesApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities [**create_entity_filter_contexts**](EntitiesApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Context Filters [**create_entity_filter_views**](EntitiesApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views [**create_entity_identity_providers**](EntitiesApi.md#create_entity_identity_providers) | **POST** /api/v1/entities/identityProviders | Post Identity Providers @@ -42,6 +43,7 @@ Method | HTTP request | Description [**delete_entity_dashboard_plugins**](EntitiesApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin [**delete_entity_data_sources**](EntitiesApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity [**delete_entity_export_definitions**](EntitiesApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition +[**delete_entity_export_templates**](EntitiesApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity [**delete_entity_filter_contexts**](EntitiesApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Context Filter [**delete_entity_filter_views**](EntitiesApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view [**delete_entity_identity_providers**](EntitiesApi.md#delete_entity_identity_providers) | **DELETE** /api/v1/entities/identityProviders/{id} | Delete Identity Provider @@ -74,6 +76,7 @@ Method | HTTP request | Description [**get_all_entities_datasets**](EntitiesApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets [**get_all_entities_entitlements**](EntitiesApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements [**get_all_entities_export_definitions**](EntitiesApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions +[**get_all_entities_export_templates**](EntitiesApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities [**get_all_entities_facts**](EntitiesApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts [**get_all_entities_filter_contexts**](EntitiesApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Context Filters [**get_all_entities_filter_views**](EntitiesApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views @@ -112,6 +115,7 @@ Method | HTTP request | Description [**get_entity_datasets**](EntitiesApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset [**get_entity_entitlements**](EntitiesApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement [**get_entity_export_definitions**](EntitiesApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition +[**get_entity_export_templates**](EntitiesApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity [**get_entity_facts**](EntitiesApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact [**get_entity_filter_contexts**](EntitiesApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Context Filter [**get_entity_filter_views**](EntitiesApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view @@ -145,6 +149,7 @@ Method | HTTP request | Description [**patch_entity_dashboard_plugins**](EntitiesApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin [**patch_entity_data_sources**](EntitiesApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity [**patch_entity_export_definitions**](EntitiesApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition +[**patch_entity_export_templates**](EntitiesApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity [**patch_entity_filter_contexts**](EntitiesApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Context Filter [**patch_entity_filter_views**](EntitiesApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view [**patch_entity_identity_providers**](EntitiesApi.md#patch_entity_identity_providers) | **PATCH** /api/v1/entities/identityProviders/{id} | Patch Identity Provider @@ -173,6 +178,7 @@ Method | HTTP request | Description [**update_entity_dashboard_plugins**](EntitiesApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin [**update_entity_data_sources**](EntitiesApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity [**update_entity_export_definitions**](EntitiesApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition +[**update_entity_export_templates**](EntitiesApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity [**update_entity_filter_contexts**](EntitiesApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Context Filter [**update_entity_filter_views**](EntitiesApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views [**update_entity_identity_providers**](EntitiesApi.md#update_entity_identity_providers) | **PUT** /api/v1/entities/identityProviders/{id} | Put Identity Provider @@ -536,7 +542,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), @@ -1235,6 +1249,147 @@ No authorization required - **Accept**: 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_export_templates** +> JsonApiExportTemplateOutDocument create_entity_export_templates(json_api_export_template_post_optional_id_document) + +Post Export Template entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_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() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + json_api_export_template_post_optional_id_document = JsonApiExportTemplatePostOptionalIdDocument( + data=JsonApiExportTemplatePostOptionalId( + attributes=JsonApiExportTemplateInAttributes( + dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="exportTemplate", + ), + ) # JsonApiExportTemplatePostOptionalIdDocument | + + # example passing only required values which don't have defaults set + try: + # Post Export Template entities + api_response = api_instance.create_entity_export_templates(json_api_export_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_export_template_post_optional_id_document** | [**JsonApiExportTemplatePostOptionalIdDocument**](JsonApiExportTemplatePostOptionalIdDocument.md)| | + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/vnd.gooddata.api+json + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -3648,6 +3803,79 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_export_templates** +> delete_entity_export_templates(id) + +Delete Export Template 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 = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete Export Template entity + api_instance.delete_entity_export_templates(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Export Template entity + api_instance.delete_entity_export_templates(id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +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 | @@ -6234,6 +6462,84 @@ No authorization required - **Accept**: 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_export_templates** +> JsonApiExportTemplateOutList get_all_entities_export_templates() + +GET all Export Template entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + filter = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # GET all Export Template entities + api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiExportTemplateOutList**](JsonApiExportTemplateOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -9452,6 +9758,82 @@ No authorization required - **Accept**: application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_export_templates** +> JsonApiExportTemplateOutDocument get_entity_export_templates(id) + +GET Export Template entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # GET Export Template entity + api_response = api_instance.get_entity_export_templates(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # GET Export Template entity + api_response = api_instance.get_entity_export_templates(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -11618,7 +12000,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), @@ -12430,6 +12820,160 @@ No authorization required - **Accept**: application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_export_templates** +> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) + +Patch Export Template entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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_export_template_patch_document = JsonApiExportTemplatePatchDocument( + data=JsonApiExportTemplatePatch( + attributes=JsonApiExportTemplatePatchAttributes( + dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="exportTemplate", + ), + ) # JsonApiExportTemplatePatchDocument | + filter = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Export Template entity + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Export Template entity + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/vnd.gooddata.api+json + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -13249,6 +13793,9 @@ with gooddata_api_client.ApiClient() as api_client: oauth_custom_auth_attributes={ "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", @@ -14493,7 +15040,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), @@ -15305,6 +15860,160 @@ No authorization required - **Accept**: 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_export_templates** +> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document) + +PUT Export Template entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_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() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_export_template_in_document = JsonApiExportTemplateInDocument( + data=JsonApiExportTemplateIn( + attributes=JsonApiExportTemplateInAttributes( + dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="exportTemplate", + ), + ) # JsonApiExportTemplateInDocument | + filter = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # PUT Export Template entity + api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # PUT Export Template entity + api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/vnd.gooddata.api+json + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -16124,6 +16833,9 @@ with gooddata_api_client.ApiClient() as api_client: oauth_custom_auth_attributes={ "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", diff --git a/gooddata-api-client/docs/ExecutionSettings.md b/gooddata-api-client/docs/ExecutionSettings.md index 2205edc34..e31c1f582 100644 --- a/gooddata-api-client/docs/ExecutionSettings.md +++ b/gooddata-api-client/docs/ExecutionSettings.md @@ -6,6 +6,7 @@ Various settings affecting the process of AFM execution or its result Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_sampling_percentage** | **float** | Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views. | [optional] +**timestamp** | **datetime** | Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/GetSlidesExport202ResponseInner.md b/gooddata-api-client/docs/GetSlidesExport202ResponseInner.md new file mode 100644 index 000000000..52cf9faf3 --- /dev/null +++ b/gooddata-api-client/docs/GetSlidesExport202ResponseInner.md @@ -0,0 +1,19 @@ +# GetSlidesExport202ResponseInner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**char** | **str** | | [optional] +**direct** | **bool** | | [optional] +**double** | **float** | | [optional] +**float** | **float** | | [optional] +**int** | **int** | | [optional] +**long** | **int** | | [optional] +**read_only** | **bool** | | [optional] +**short** | **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/IntroSlideTemplate.md b/gooddata-api-client/docs/IntroSlideTemplate.md new file mode 100644 index 000000000..b9c75a666 --- /dev/null +++ b/gooddata-api-client/docs/IntroSlideTemplate.md @@ -0,0 +1,17 @@ +# IntroSlideTemplate + +Settings for intro slide. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_image** | **bool** | Show background image on the slide. | [optional] if omitted the server will use the default value of True +**description_field** | **str, none_type** | | [optional] +**footer** | [**RunningSection**](RunningSection.md) | | [optional] +**header** | [**RunningSection**](RunningSection.md) | | [optional] +**title_field** | **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/JsonApiAutomationInAttributes.md b/gooddata-api-client/docs/JsonApiAutomationInAttributes.md index 8c324adac..591cf3957 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributes.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **description** | **str** | | [optional] **details** | **bool, date, datetime, dict, float, int, list, str, none_type** | Additional details to be included in the automated message. | [optional] **external_recipients** | [**[JsonApiAutomationInAttributesExternalRecipientsInner]**](JsonApiAutomationInAttributesExternalRecipientsInner.md) | External recipients of the automation action results. | [optional] -**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Additional information for the automation. | [optional] +**metadata** | [**JsonApiAutomationInAttributesMetadata**](JsonApiAutomationInAttributesMetadata.md) | | [optional] **schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] **state** | **str** | Current state of the automation. | [optional] **tabular_exports** | [**[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesMetadata.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesMetadata.md new file mode 100644 index 000000000..07d7f983a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesMetadata.md @@ -0,0 +1,14 @@ +# JsonApiAutomationInAttributesMetadata + +Additional information for the automation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visible_filters** | [**[VisibleFilter]**](VisibleFilter.md) | | [optional] +**widget** | **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/JsonApiAutomationOutAttributes.md b/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md index 764afd46c..582de309c 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **description** | **str** | | [optional] **details** | **bool, date, datetime, dict, float, int, list, str, none_type** | Additional details to be included in the automated message. | [optional] **external_recipients** | [**[JsonApiAutomationInAttributesExternalRecipientsInner]**](JsonApiAutomationInAttributesExternalRecipientsInner.md) | External recipients of the automation action results. | [optional] -**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Additional information for the automation. | [optional] +**metadata** | [**JsonApiAutomationInAttributesMetadata**](JsonApiAutomationInAttributesMetadata.md) | | [optional] **modified_at** | **datetime** | | [optional] **schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] **state** | **str** | Current state of the automation. | [optional] diff --git a/gooddata-api-client/docs/JsonApiExportTemplateIn.md b/gooddata-api-client/docs/JsonApiExportTemplateIn.md new file mode 100644 index 000000000..e34ef1ee1 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateIn.md @@ -0,0 +1,15 @@ +# JsonApiExportTemplateIn + +JSON:API representation of exportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiExportTemplateInAttributes**](JsonApiExportTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "exportTemplate" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiExportTemplateInAttributes.md b/gooddata-api-client/docs/JsonApiExportTemplateInAttributes.md new file mode 100644 index 000000000..636076248 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateInAttributes.md @@ -0,0 +1,14 @@ +# JsonApiExportTemplateInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | User-facing name of the Slides template. | +**dashboard_slides_template** | [**JsonApiExportTemplateInAttributesDashboardSlidesTemplate**](JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md) | | [optional] +**widget_slides_template** | [**JsonApiExportTemplateInAttributesWidgetSlidesTemplate**](JsonApiExportTemplateInAttributesWidgetSlidesTemplate.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/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md b/gooddata-api-client/docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md new file mode 100644 index 000000000..3a45ee9b9 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md @@ -0,0 +1,17 @@ +# JsonApiExportTemplateInAttributesDashboardSlidesTemplate + +Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applied_on** | **[str]** | Export types this template applies to. | +**content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**cover_slide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**intro_slide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**section_slide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md b/gooddata-api-client/docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md new file mode 100644 index 000000000..17c03ec4a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateInAttributesWidgetSlidesTemplate.md @@ -0,0 +1,14 @@ +# JsonApiExportTemplateInAttributesWidgetSlidesTemplate + +Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applied_on** | **[str]** | Export types this template applies to. | +**content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiExportTemplateInDocument.md b/gooddata-api-client/docs/JsonApiExportTemplateInDocument.md new file mode 100644 index 000000000..cbfb968c2 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateInDocument.md @@ -0,0 +1,12 @@ +# JsonApiExportTemplateInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiExportTemplateIn**](JsonApiExportTemplateIn.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/JsonApiExportTemplateOut.md b/gooddata-api-client/docs/JsonApiExportTemplateOut.md new file mode 100644 index 000000000..034f2558e --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateOut.md @@ -0,0 +1,15 @@ +# JsonApiExportTemplateOut + +JSON:API representation of exportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiExportTemplateInAttributes**](JsonApiExportTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "exportTemplate" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiExportTemplateOutDocument.md b/gooddata-api-client/docs/JsonApiExportTemplateOutDocument.md new file mode 100644 index 000000000..474e4e402 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateOutDocument.md @@ -0,0 +1,13 @@ +# JsonApiExportTemplateOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiExportTemplateOut**](JsonApiExportTemplateOut.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/JsonApiExportTemplateOutList.md b/gooddata-api-client/docs/JsonApiExportTemplateOutList.md new file mode 100644 index 000000000..750db0e3a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateOutList.md @@ -0,0 +1,15 @@ +# JsonApiExportTemplateOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiExportTemplateOutWithLinks]**](JsonApiExportTemplateOutWithLinks.md) | | +**links** | [**ListLinks**](ListLinks.md) | | [optional] +**meta** | [**JsonApiAnalyticalDashboardOutListMeta**](JsonApiAnalyticalDashboardOutListMeta.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/JsonApiExportTemplateOutWithLinks.md b/gooddata-api-client/docs/JsonApiExportTemplateOutWithLinks.md new file mode 100644 index 000000000..5192d97c5 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplateOutWithLinks.md @@ -0,0 +1,15 @@ +# JsonApiExportTemplateOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiExportTemplateInAttributes**](JsonApiExportTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "exportTemplate" +**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/JsonApiExportTemplatePatch.md b/gooddata-api-client/docs/JsonApiExportTemplatePatch.md new file mode 100644 index 000000000..2c7ac4dd3 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplatePatch.md @@ -0,0 +1,15 @@ +# JsonApiExportTemplatePatch + +JSON:API representation of patching exportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiExportTemplatePatchAttributes**](JsonApiExportTemplatePatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "exportTemplate" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiExportTemplatePatchAttributes.md b/gooddata-api-client/docs/JsonApiExportTemplatePatchAttributes.md new file mode 100644 index 000000000..c2dc46e4a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplatePatchAttributes.md @@ -0,0 +1,14 @@ +# JsonApiExportTemplatePatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dashboard_slides_template** | [**JsonApiExportTemplateInAttributesDashboardSlidesTemplate**](JsonApiExportTemplateInAttributesDashboardSlidesTemplate.md) | | [optional] +**name** | **str** | User-facing name of the Slides template. | [optional] +**widget_slides_template** | [**JsonApiExportTemplateInAttributesWidgetSlidesTemplate**](JsonApiExportTemplateInAttributesWidgetSlidesTemplate.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/JsonApiExportTemplatePatchDocument.md b/gooddata-api-client/docs/JsonApiExportTemplatePatchDocument.md new file mode 100644 index 000000000..d63641e16 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplatePatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiExportTemplatePatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiExportTemplatePatch**](JsonApiExportTemplatePatch.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/JsonApiExportTemplatePostOptionalId.md b/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalId.md new file mode 100644 index 000000000..9b083ddbc --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiExportTemplatePostOptionalId + +JSON:API representation of exportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiExportTemplateInAttributes**](JsonApiExportTemplateInAttributes.md) | | +**type** | **str** | Object type | defaults to "exportTemplate" +**id** | **str** | API identifier of an object | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalIdDocument.md new file mode 100644 index 000000000..bbae07f4c --- /dev/null +++ b/gooddata-api-client/docs/JsonApiExportTemplatePostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiExportTemplatePostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiExportTemplatePostOptionalId**](JsonApiExportTemplatePostOptionalId.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/JsonApiOrganizationInAttributes.md b/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md index 5953982f1..f493c7bc2 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md +++ b/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **oauth_client_id** | **str** | | [optional] **oauth_client_secret** | **str** | | [optional] **oauth_custom_auth_attributes** | **{str: (str,)}** | 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] +**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **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] **oauth_issuer_location** | **str** | | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md b/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md index 8b22cfa19..ec416ad3e 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **name** | **str, none_type** | | [optional] **oauth_client_id** | **str** | | [optional] **oauth_custom_auth_attributes** | **{str: (str,)}** | 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] +**oauth_custom_scopes** | **[str], none_type** | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] **oauth_issuer_id** | **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] **oauth_issuer_location** | **str** | | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index 3d15ad7ba..c7d06731b 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -8,6 +8,7 @@ Method | HTTP request | Description [**get_automations**](LayoutApi.md#get_automations) | **GET** /api/v1/layout/workspaces/{workspaceId}/automations | Get automations [**get_data_source_permissions**](LayoutApi.md#get_data_source_permissions) | **GET** /api/v1/layout/dataSources/{dataSourceId}/permissions | Get permissions for the data source [**get_data_sources_layout**](LayoutApi.md#get_data_sources_layout) | **GET** /api/v1/layout/dataSources | Get all data sources +[**get_export_templates_layout**](LayoutApi.md#get_export_templates_layout) | **GET** /api/v1/layout/exportTemplates | Get all export templates layout [**get_filter_views**](LayoutApi.md#get_filter_views) | **GET** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views [**get_identity_providers_layout**](LayoutApi.md#get_identity_providers_layout) | **GET** /api/v1/layout/identityProviders | Get all identity providers layout [**get_logical_model**](LayoutApi.md#get_logical_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Get logical model @@ -32,6 +33,7 @@ Method | HTTP request | Description [**set_analytics_model**](LayoutApi.md#set_analytics_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Set analytics model [**set_automations**](LayoutApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations [**set_data_source_permissions**](LayoutApi.md#set_data_source_permissions) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/permissions | Set data source permissions. +[**set_export_templates**](LayoutApi.md#set_export_templates) | **PUT** /api/v1/layout/exportTemplates | Set all export templates [**set_filter_views**](LayoutApi.md#set_filter_views) | **PUT** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views [**set_identity_providers**](LayoutApi.md#set_identity_providers) | **PUT** /api/v1/layout/identityProviders | Set all identity providers [**set_logical_model**](LayoutApi.md#set_logical_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Set logical model @@ -336,6 +338,69 @@ No authorization required [[Back to top]](#) [[Back 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 time +import gooddata_api_client +from gooddata_api_client.api import layout_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() as api_client: + # Create an instance of the API class + api_instance = layout_api.LayoutApi(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 LayoutApi->get_export_templates_layout: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**DeclarativeExportTemplates**](DeclarativeExportTemplates.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Retrieved layout of all export templates. | - | + +[[Back to top]](#) [[Back 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) @@ -2463,7 +2528,15 @@ with gooddata_api_client.ApiClient() as api_client: ), ], id="/6bUUGjjNSwg0_bs", - metadata=JsonNode(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -2663,6 +2736,146 @@ No authorization required [[Back to top]](#) [[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 time +import gooddata_api_client +from gooddata_api_client.api import layout_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() as api_client: + # Create an instance of the API class + api_instance = layout_api.LayoutApi(api_client) + declarative_export_templates = 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", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + ], + ) # DeclarativeExportTemplates | + + # example passing only required values which don't have defaults set + try: + # Set all export templates + api_instance.set_export_templates(declarative_export_templates) + except gooddata_api_client.ApiException as e: + print("Exception when calling LayoutApi->set_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **declarative_export_templates** | [**DeclarativeExportTemplates**](DeclarativeExportTemplates.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** | All export templates set. | - | + +[[Back to top]](#) [[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_id, declarative_filter_view) @@ -3174,6 +3387,79 @@ with gooddata_api_client.ApiClient() as api_client: username="demo", ), ], + 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", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + ], identity_providers=[ DeclarativeIdentityProvider( custom_claim_mapping={ @@ -3236,6 +3522,9 @@ with gooddata_api_client.ApiClient() as api_client: oauth_custom_auth_attributes={ "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", @@ -3401,7 +3690,15 @@ with gooddata_api_client.ApiClient() as api_client: ), ], id="/6bUUGjjNSwg0_bs", - metadata=JsonNode(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -4491,7 +4788,15 @@ with gooddata_api_client.ApiClient() as api_client: ), ], id="/6bUUGjjNSwg0_bs", - metadata=JsonNode(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", diff --git a/gooddata-api-client/docs/NotificationChannelsApi.md b/gooddata-api-client/docs/NotificationChannelsApi.md index 7aadd2daf..075c16494 100644 --- a/gooddata-api-client/docs/NotificationChannelsApi.md +++ b/gooddata-api-client/docs/NotificationChannelsApi.md @@ -8,11 +8,13 @@ Method | HTTP request | Description [**delete_entity_notification_channels**](NotificationChannelsApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity [**get_all_entities_notification_channels**](NotificationChannelsApi.md#get_all_entities_notification_channels) | **GET** /api/v1/entities/notificationChannels | Get all Notification Channel entities [**get_entity_notification_channels**](NotificationChannelsApi.md#get_entity_notification_channels) | **GET** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity +[**get_export_templates_layout**](NotificationChannelsApi.md#get_export_templates_layout) | **GET** /api/v1/layout/exportTemplates | Get all export templates layout [**get_notification_channels_layout**](NotificationChannelsApi.md#get_notification_channels_layout) | **GET** /api/v1/layout/notificationChannels | Get all notification channels layout [**get_notifications**](NotificationChannelsApi.md#get_notifications) | **GET** /api/v1/actions/notifications | Get latest notifications. [**mark_as_read_notification**](NotificationChannelsApi.md#mark_as_read_notification) | **POST** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read. [**mark_as_read_notification_all**](NotificationChannelsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. [**patch_entity_notification_channels**](NotificationChannelsApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity +[**set_export_templates**](NotificationChannelsApi.md#set_export_templates) | **PUT** /api/v1/layout/exportTemplates | Set all export templates [**set_notification_channels**](NotificationChannelsApi.md#set_notification_channels) | **PUT** /api/v1/layout/notificationChannels | Set all notification channels [**test_existing_notification_channel**](NotificationChannelsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel. [**test_notification_channel**](NotificationChannelsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel. @@ -326,6 +328,69 @@ No authorization required [[Back to top]](#) [[Back 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 time +import gooddata_api_client +from gooddata_api_client.api 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() 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 type + +[**DeclarativeExportTemplates**](DeclarativeExportTemplates.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Retrieved layout of all export templates. | - | + +[[Back to top]](#) [[Back 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() @@ -691,6 +756,146 @@ No authorization required [[Back to top]](#) [[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 time +import gooddata_api_client +from gooddata_api_client.api 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() as api_client: + # Create an instance of the API class + api_instance = notification_channels_api.NotificationChannelsApi(api_client) + declarative_export_templates = 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", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + ], + ) # DeclarativeExportTemplates | + + # example passing only required values which don't have defaults set + try: + # Set all export templates + api_instance.set_export_templates(declarative_export_templates) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->set_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **declarative_export_templates** | [**DeclarativeExportTemplates**](DeclarativeExportTemplates.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** | All export templates set. | - | + +[[Back to top]](#) [[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) diff --git a/gooddata-api-client/docs/OrganizationControllerApi.md b/gooddata-api-client/docs/OrganizationControllerApi.md index 42ba85705..a7676cb39 100644 --- a/gooddata-api-client/docs/OrganizationControllerApi.md +++ b/gooddata-api-client/docs/OrganizationControllerApi.md @@ -304,6 +304,9 @@ with gooddata_api_client.ApiClient() as api_client: oauth_custom_auth_attributes={ "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", @@ -499,6 +502,9 @@ with gooddata_api_client.ApiClient() as api_client: oauth_custom_auth_attributes={ "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", diff --git a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index 1f66301eb..0f7baac9d 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -144,6 +144,79 @@ with gooddata_api_client.ApiClient() as api_client: username="demo", ), ], + 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", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + ], identity_providers=[ DeclarativeIdentityProvider( custom_claim_mapping={ @@ -206,6 +279,9 @@ with gooddata_api_client.ApiClient() as api_client: oauth_custom_auth_attributes={ "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", @@ -371,7 +447,15 @@ with gooddata_api_client.ApiClient() as api_client: ), ], id="/6bUUGjjNSwg0_bs", - metadata=JsonNode(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", diff --git a/gooddata-api-client/docs/OrganizationEntityAPIsApi.md b/gooddata-api-client/docs/OrganizationEntityAPIsApi.md index 3676b98a4..29ddf7570 100644 --- a/gooddata-api-client/docs/OrganizationEntityAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationEntityAPIsApi.md @@ -602,6 +602,9 @@ with gooddata_api_client.ApiClient() as api_client: oauth_custom_auth_attributes={ "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", @@ -797,6 +800,9 @@ with gooddata_api_client.ApiClient() as api_client: oauth_custom_auth_attributes={ "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", diff --git a/gooddata-api-client/docs/OrganizationModelControllerApi.md b/gooddata-api-client/docs/OrganizationModelControllerApi.md index fdde7c7e9..16734c64b 100644 --- a/gooddata-api-client/docs/OrganizationModelControllerApi.md +++ b/gooddata-api-client/docs/OrganizationModelControllerApi.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**create_entity_color_palettes**](OrganizationModelControllerApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes [**create_entity_csp_directives**](OrganizationModelControllerApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives [**create_entity_data_sources**](OrganizationModelControllerApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources +[**create_entity_export_templates**](OrganizationModelControllerApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities [**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 @@ -19,6 +20,7 @@ Method | HTTP request | Description [**delete_entity_color_palettes**](OrganizationModelControllerApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette [**delete_entity_csp_directives**](OrganizationModelControllerApi.md#delete_entity_csp_directives) | **DELETE** /api/v1/entities/cspDirectives/{id} | Delete CSP Directives [**delete_entity_data_sources**](OrganizationModelControllerApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity +[**delete_entity_export_templates**](OrganizationModelControllerApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity [**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} | @@ -33,6 +35,7 @@ Method | HTTP request | Description [**get_all_entities_data_source_identifiers**](OrganizationModelControllerApi.md#get_all_entities_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers [**get_all_entities_data_sources**](OrganizationModelControllerApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities [**get_all_entities_entitlements**](OrganizationModelControllerApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements +[**get_all_entities_export_templates**](OrganizationModelControllerApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities [**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 @@ -48,6 +51,7 @@ Method | HTTP request | Description [**get_entity_data_source_identifiers**](OrganizationModelControllerApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier [**get_entity_data_sources**](OrganizationModelControllerApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity [**get_entity_entitlements**](OrganizationModelControllerApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement +[**get_entity_export_templates**](OrganizationModelControllerApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity [**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 @@ -61,6 +65,7 @@ Method | HTTP request | Description [**patch_entity_color_palettes**](OrganizationModelControllerApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette [**patch_entity_csp_directives**](OrganizationModelControllerApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives [**patch_entity_data_sources**](OrganizationModelControllerApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity +[**patch_entity_export_templates**](OrganizationModelControllerApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity [**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 @@ -73,6 +78,7 @@ Method | HTTP request | Description [**update_entity_color_palettes**](OrganizationModelControllerApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette [**update_entity_csp_directives**](OrganizationModelControllerApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives [**update_entity_data_sources**](OrganizationModelControllerApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity +[**update_entity_export_templates**](OrganizationModelControllerApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity [**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 @@ -335,6 +341,147 @@ No authorization required - **Accept**: 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_export_templates** +> JsonApiExportTemplateOutDocument create_entity_export_templates(json_api_export_template_post_optional_id_document) + +Post Export Template 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_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() as api_client: + # Create an instance of the API class + api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) + json_api_export_template_post_optional_id_document = JsonApiExportTemplatePostOptionalIdDocument( + data=JsonApiExportTemplatePostOptionalId( + attributes=JsonApiExportTemplateInAttributes( + dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="exportTemplate", + ), + ) # JsonApiExportTemplatePostOptionalIdDocument | + + # example passing only required values which don't have defaults set + try: + # Post Export Template entities + api_response = api_instance.create_entity_export_templates(json_api_export_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->create_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_export_template_post_optional_id_document** | [**JsonApiExportTemplatePostOptionalIdDocument**](JsonApiExportTemplatePostOptionalIdDocument.md)| | + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/vnd.gooddata.api+json + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -1317,6 +1464,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_export_templates** +> delete_entity_export_templates(id) + +Delete Export Template 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 = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete Export Template entity + api_instance.delete_entity_export_templates(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->delete_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Export Template entity + api_instance.delete_entity_export_templates(id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->delete_entity_export_templates: %s\n" % e) +``` + + ### Parameters Name | Type | Description | Notes @@ -2397,6 +2617,84 @@ No authorization required - **Accept**: 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_export_templates** +> JsonApiExportTemplateOutList get_all_entities_export_templates() + +GET all Export Template entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) + filter = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # GET all Export Template entities + api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->get_all_entities_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiExportTemplateOutList**](JsonApiExportTemplateOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -3593,6 +3891,82 @@ No authorization required - **Accept**: application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_export_templates** +> JsonApiExportTemplateOutDocument get_entity_export_templates(id) + +GET Export Template entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # GET Export Template entity + api_response = api_instance.get_entity_export_templates(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->get_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # GET Export Template entity + api_response = api_instance.get_entity_export_templates(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->get_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -4664,6 +5038,160 @@ No authorization required - **Accept**: application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_export_templates** +> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) + +Patch Export Template 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_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() 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_export_template_patch_document = JsonApiExportTemplatePatchDocument( + data=JsonApiExportTemplatePatch( + attributes=JsonApiExportTemplatePatchAttributes( + dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="exportTemplate", + ), + ) # JsonApiExportTemplatePatchDocument | + filter = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Export Template entity + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->patch_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Export Template entity + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->patch_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/vnd.gooddata.api+json + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -5815,6 +6343,160 @@ No authorization required - **Accept**: 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_export_templates** +> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document) + +PUT Export Template 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_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() 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_export_template_in_document = JsonApiExportTemplateInDocument( + data=JsonApiExportTemplateIn( + attributes=JsonApiExportTemplateInAttributes( + dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="exportTemplate", + ), + ) # JsonApiExportTemplateInDocument | + filter = "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # PUT Export Template entity + api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->update_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # PUT Export Template entity + api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->update_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/vnd.gooddata.api+json + - **Accept**: application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/RawExportApi.md b/gooddata-api-client/docs/RawExportApi.md index 1e4f15b6b..d1d134189 100644 --- a/gooddata-api-client/docs/RawExportApi.md +++ b/gooddata-api-client/docs/RawExportApi.md @@ -81,6 +81,7 @@ with gooddata_api_client.ApiClient() as api_client: ), execution_settings=ExecutionSettings( data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), ), file_name="result", format="CSV", diff --git a/gooddata-api-client/docs/RunningSection.md b/gooddata-api-client/docs/RunningSection.md new file mode 100644 index 000000000..040b90bae --- /dev/null +++ b/gooddata-api-client/docs/RunningSection.md @@ -0,0 +1,14 @@ +# RunningSection + +Footer section of the slide + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left** | **str, none_type** | Either {{logo}} variable or custom text with combination of other variables. | [optional] +**right** | **str, none_type** | Either {{logo}} variable or custom text with combination of other variables. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/SectionSlideTemplate.md b/gooddata-api-client/docs/SectionSlideTemplate.md new file mode 100644 index 000000000..b69720f8f --- /dev/null +++ b/gooddata-api-client/docs/SectionSlideTemplate.md @@ -0,0 +1,15 @@ +# SectionSlideTemplate + +Settings for section slide. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_image** | **bool** | Show background image on the slide. | [optional] if omitted the server will use the default value of True +**footer** | [**RunningSection**](RunningSection.md) | | [optional] +**header** | [**RunningSection**](RunningSection.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/SlideshowExportApi.md b/gooddata-api-client/docs/SlidesExportApi.md similarity index 82% rename from gooddata-api-client/docs/SlideshowExportApi.md rename to gooddata-api-client/docs/SlidesExportApi.md index 6c9bf1afb..96f7e41f6 100644 --- a/gooddata-api-client/docs/SlideshowExportApi.md +++ b/gooddata-api-client/docs/SlidesExportApi.md @@ -1,12 +1,12 @@ -# gooddata_api_client.SlideshowExportApi +# gooddata_api_client.SlidesExportApi All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_slides_export**](SlideshowExportApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request -[**get_slides_export**](SlideshowExportApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files -[**get_slides_export_metadata**](SlideshowExportApi.md#get_slides_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context +[**create_slides_export**](SlidesExportApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request +[**get_slides_export**](SlidesExportApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files +[**get_slides_export_metadata**](SlidesExportApi.md#get_slides_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context # **create_slides_export** @@ -22,7 +22,7 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python import time import gooddata_api_client -from gooddata_api_client.api import slideshow_export_api +from gooddata_api_client.api 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 @@ -36,13 +36,17 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = slideshow_export_api.SlideshowExportApi(api_client) + api_instance = slides_export_api.SlidesExportApi(api_client) workspace_id = "workspaceId_example" # str | slides_export_request = 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", ], @@ -54,7 +58,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.create_slides_export(workspace_id, slides_export_request) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling SlideshowExportApi->create_slides_export: %s\n" % e) + print("Exception when calling SlidesExportApi->create_slides_export: %s\n" % e) ``` @@ -100,7 +104,8 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python import time import gooddata_api_client -from gooddata_api_client.api import slideshow_export_api +from gooddata_api_client.api import slides_export_api +from gooddata_api_client.model.get_slides_export202_response_inner import GetSlidesExport202ResponseInner from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -112,7 +117,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = slideshow_export_api.SlideshowExportApi(api_client) + api_instance = slides_export_api.SlidesExportApi(api_client) workspace_id = "workspaceId_example" # str | export_id = "exportId_example" # str | @@ -121,7 +126,7 @@ with gooddata_api_client.ApiClient() as api_client: # (EXPERIMENTAL) Retrieve exported files api_instance.get_slides_export(workspace_id, export_id) except gooddata_api_client.ApiException as e: - print("Exception when calling SlideshowExportApi->get_slides_export: %s\n" % e) + print("Exception when calling SlidesExportApi->get_slides_export: %s\n" % e) ``` @@ -168,7 +173,7 @@ Note: This API is an experimental and is going to change. Please, use it accordi ```python import time import gooddata_api_client -from gooddata_api_client.api import slideshow_export_api +from gooddata_api_client.api 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. @@ -180,7 +185,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = slideshow_export_api.SlideshowExportApi(api_client) + api_instance = slides_export_api.SlidesExportApi(api_client) workspace_id = "workspaceId_example" # str | export_id = "exportId_example" # str | @@ -189,7 +194,7 @@ with gooddata_api_client.ApiClient() as api_client: # (EXPERIMENTAL) Retrieve metadata context api_instance.get_slides_export_metadata(workspace_id, export_id) except gooddata_api_client.ApiException as e: - print("Exception when calling SlideshowExportApi->get_slides_export_metadata: %s\n" % e) + print("Exception when calling SlidesExportApi->get_slides_export_metadata: %s\n" % e) ``` diff --git a/gooddata-api-client/docs/SlidesExportRequest.md b/gooddata-api-client/docs/SlidesExportRequest.md index c01b93825..6844f53ac 100644 --- a/gooddata-api-client/docs/SlidesExportRequest.md +++ b/gooddata-api-client/docs/SlidesExportRequest.md @@ -5,10 +5,12 @@ Export request object describing the export properties and metadata for slides e ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dashboard_id** | **str** | Dashboard identifier | **file_name** | **str** | File name to be used for retrieving the pdf document. | **format** | **str** | Requested resulting file type. | +**dashboard_id** | **str** | Dashboard identifier | [optional] **metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**template_id** | **str, none_type** | Export template identifier. | [optional] +**visualization_ids** | **[str]** | List of visualization ids to be exported. Note that only one visualization is currently supported. | [optional] **widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/VisibleFilter.md b/gooddata-api-client/docs/VisibleFilter.md new file mode 100644 index 000000000..de43121ce --- /dev/null +++ b/gooddata-api-client/docs/VisibleFilter.md @@ -0,0 +1,13 @@ +# VisibleFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**local_identifier** | **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/WidgetSlidesTemplate.md b/gooddata-api-client/docs/WidgetSlidesTemplate.md new file mode 100644 index 000000000..de38ac034 --- /dev/null +++ b/gooddata-api-client/docs/WidgetSlidesTemplate.md @@ -0,0 +1,14 @@ +# WidgetSlidesTemplate + +Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applied_on** | **[str]** | Export types this template applies to. | +**content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md index f890905d1..8adcbd45e 100644 --- a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md @@ -367,7 +367,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), @@ -6235,7 +6243,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), @@ -7764,7 +7780,15 @@ with gooddata_api_client.ApiClient() as api_client: email="email_example", ), ], - metadata={}, + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), schedule=JsonApiAutomationInAttributesSchedule( cron="0 */30 9-17 ? * MON-FRI", first_run=dateutil_parser('2025-01-01T12:00:00Z'), diff --git a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index 3c34ca84e..ec4275f86 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -611,7 +611,15 @@ with gooddata_api_client.ApiClient() as api_client: ), ], id="/6bUUGjjNSwg0_bs", - metadata=JsonNode(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", 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 246127474..b40871dc5 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -22,6 +22,7 @@ none_type, validate_and_convert_types ) +from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens from gooddata_api_client.model.afm_execution import AfmExecution from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse from gooddata_api_client.model.afm_valid_descendants_query import AfmValidDescendantsQuery @@ -54,6 +55,7 @@ from gooddata_api_client.model.forecast_request import ForecastRequest from gooddata_api_client.model.forecast_result import ForecastResult from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.model.get_slides_export202_response_inner import GetSlidesExport202ResponseInner from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification from gooddata_api_client.model.identifier_duplications import IdentifierDuplications from gooddata_api_client.model.key_drivers_request import KeyDriversRequest @@ -596,6 +598,69 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.cancel_executions_endpoint = _Endpoint( + settings={ + 'response_type': (AfmCancelTokens,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel', + 'operation_id': 'cancel_executions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'afm_cancel_tokens', + ], + 'required': [ + 'workspace_id', + 'afm_cancel_tokens', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'afm_cancel_tokens': + (AfmCancelTokens,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'afm_cancel_tokens': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.check_entity_overrides_endpoint = _Endpoint( settings={ 'response_type': ([IdentifierDuplications],), @@ -3619,6 +3684,7 @@ def __init__(self, api_client=None): 'offset', 'limit', 'excluded_total_dimensions', + 'x_gdc_cancel_token', ], 'required': [ 'workspace_id', @@ -3654,6 +3720,8 @@ def __init__(self, api_client=None): ([int],), 'excluded_total_dimensions': ([str],), + 'x_gdc_cancel_token': + (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', @@ -3661,6 +3729,7 @@ def __init__(self, api_client=None): 'offset': 'offset', 'limit': 'limit', 'excluded_total_dimensions': 'excludedTotalDimensions', + 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', }, 'location_map': { 'workspace_id': 'path', @@ -3668,6 +3737,7 @@ def __init__(self, api_client=None): 'offset': 'query', 'limit': 'query', 'excluded_total_dimensions': 'query', + 'x_gdc_cancel_token': 'header', }, 'collection_format_map': { 'offset': 'csv', @@ -5183,6 +5253,93 @@ def available_assignees( dashboard_id return self.available_assignees_endpoint.call_with_http_info(**kwargs) + def cancel_executions( + self, + workspace_id, + afm_cancel_tokens, + **kwargs + ): + """Applies all the given cancel tokens. # noqa: E501 + + Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is canceled. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.cancel_executions(workspace_id, afm_cancel_tokens, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + afm_cancel_tokens (AfmCancelTokens): + + 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: + AfmCancelTokens + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['afm_cancel_tokens'] = \ + afm_cancel_tokens + return self.cancel_executions_endpoint.call_with_http_info(**kwargs) + def check_entity_overrides( self, workspace_id, @@ -9660,6 +9817,7 @@ def retrieve_result( 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 diff --git a/gooddata-api-client/gooddata_api_client/api/computation_api.py b/gooddata-api-client/gooddata_api_client/api/computation_api.py index 3a0a13d64..19024a708 100644 --- a/gooddata-api-client/gooddata_api_client/api/computation_api.py +++ b/gooddata-api-client/gooddata_api_client/api/computation_api.py @@ -640,6 +640,7 @@ def __init__(self, api_client=None): 'offset', 'limit', 'excluded_total_dimensions', + 'x_gdc_cancel_token', ], 'required': [ 'workspace_id', @@ -675,6 +676,8 @@ def __init__(self, api_client=None): ([int],), 'excluded_total_dimensions': ([str],), + 'x_gdc_cancel_token': + (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', @@ -682,6 +685,7 @@ def __init__(self, api_client=None): 'offset': 'offset', 'limit': 'limit', 'excluded_total_dimensions': 'excludedTotalDimensions', + 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', }, 'location_map': { 'workspace_id': 'path', @@ -689,6 +693,7 @@ def __init__(self, api_client=None): 'offset': 'query', 'limit': 'query', 'excluded_total_dimensions': 'query', + 'x_gdc_cancel_token': 'header', }, 'collection_format_map': { 'offset': 'csv', @@ -1433,6 +1438,7 @@ def retrieve_result( 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 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 63deec780..91036ea2e 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -76,6 +76,11 @@ from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument @@ -929,6 +934,56 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates', + 'operation_id': 'create_entity_export_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_export_template_post_optional_id_document', + ], + 'required': [ + 'json_api_export_template_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'json_api_export_template_post_optional_id_document': + (JsonApiExportTemplatePostOptionalIdDocument,), + }, + 'attribute_map': { + }, + 'location_map': { + 'json_api_export_template_post_optional_id_document': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.create_entity_filter_contexts_endpoint = _Endpoint( settings={ 'response_type': (JsonApiFilterContextOutDocument,), @@ -2763,6 +2818,65 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'delete_entity_export_templates', + '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_filter_contexts_endpoint = _Endpoint( settings={ 'response_type': None, @@ -5277,6 +5391,86 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates', + 'operation_id': 'get_all_entities_export_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_facts_endpoint = _Endpoint( settings={ 'response_type': (JsonApiFactOutList,), @@ -8726,6 +8920,67 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'get_entity_export_templates', + '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/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_entity_facts_endpoint = _Endpoint( settings={ 'response_type': (JsonApiFactOutDocument,), @@ -11317,46 +11572,114 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_filter_contexts_endpoint = _Endpoint( + self.patch_entity_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFilterContextOutDocument,), + 'response_type': (JsonApiExportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'patch_entity_filter_contexts', + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'patch_entity_export_templates', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', + 'id', + 'json_api_export_template_patch_document', 'filter', - 'include', ], 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', + 'id', + 'json_api_export_template_patch_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ + 'id', ] }, root_map={ 'validations': { - }, - 'allowed_values': { - ('include',): { + ('id',): { - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_export_template_patch_document': + (JsonApiExportTemplatePatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_export_template_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.patch_entity_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterContextOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + 'operation_id': 'patch_entity_filter_contexts', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_filter_context_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_filter_context_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "DATASETS": "datasets", + "LABELS": "labels", + "ALL": "ALL" }, }, 'openapi_types': { @@ -13464,6 +13787,74 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'update_entity_export_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_export_template_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_export_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_export_template_in_document': + (JsonApiExportTemplateInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_export_template_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.update_entity_filter_contexts_endpoint = _Endpoint( settings={ 'response_type': (JsonApiFilterContextOutDocument,), @@ -15783,6 +16174,88 @@ def create_entity_export_definitions( json_api_export_definition_post_optional_id_document return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + def create_entity_export_templates( + self, + json_api_export_template_post_optional_id_document, + **kwargs + ): + """Post Export Template entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_export_template_post_optional_id_document'] = \ + json_api_export_template_post_optional_id_document + return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def create_entity_filter_contexts( self, workspace_id, @@ -18177,6 +18650,89 @@ def delete_entity_export_definitions( 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) + def delete_entity_filter_contexts( self, workspace_id, @@ -20809,7 +21365,95 @@ def get_all_entities_entitlements( async_req (bool): execute request asynchronously Returns: - JsonApiEntitlementOutList + JsonApiEntitlementOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_export_definitions( + self, + workspace_id, + **kwargs + ): + """Get all Export Definitions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutList If the method is called asynchronously, returns the request thread. """ @@ -20838,32 +21482,28 @@ def get_all_entities_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_definitions( + def get_all_entities_export_templates( self, - workspace_id, **kwargs ): - """Get all Export Definitions # noqa: E501 + """GET all Export Template entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) + >>> thread = api.get_all_entities_export_templates(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -20897,7 +21537,7 @@ def get_all_entities_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutList + JsonApiExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -20926,9 +21566,7 @@ def get_all_entities_export_definitions( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) def get_all_entities_facts( self, @@ -24209,6 +24847,89 @@ def get_entity_export_definitions( object_id return self.get_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + def get_entity_export_templates( + self, + id, + **kwargs + ): + """GET Export Template entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_export_templates(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def get_entity_facts( self, workspace_id, @@ -27098,6 +27819,93 @@ def patch_entity_export_definitions( json_api_export_definition_patch_document return self.patch_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + def patch_entity_export_templates( + self, + id, + json_api_export_template_patch_document, + **kwargs + ): + """Patch Export Template entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_export_template_patch_document'] = \ + json_api_export_template_patch_document + return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def patch_entity_filter_contexts( self, workspace_id, @@ -29612,6 +30420,93 @@ def update_entity_export_definitions( json_api_export_definition_in_document return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + def update_entity_export_templates( + self, + id, + json_api_export_template_in_document, + **kwargs + ): + """PUT Export Template entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_export_template_in_document (JsonApiExportTemplateInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_export_template_in_document'] = \ + json_api_export_template_in_document + return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def update_entity_filter_contexts( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/layout_api.py b/gooddata-api-client/gooddata_api_client/api/layout_api.py index 3f052fe96..0771997a4 100644 --- a/gooddata-api-client/gooddata_api_client/api/layout_api.py +++ b/gooddata-api-client/gooddata_api_client/api/layout_api.py @@ -26,6 +26,7 @@ from gooddata_api_client.model.declarative_automation import DeclarativeAutomation from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider from gooddata_api_client.model.declarative_model import DeclarativeModel @@ -266,6 +267,48 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_export_templates_layout_endpoint = _Endpoint( + settings={ + 'response_type': (DeclarativeExportTemplates,), + 'auth': [], + 'endpoint_path': '/api/v1/layout/exportTemplates', + 'operation_id': 'get_export_templates_layout', + '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.get_filter_views_endpoint = _Endpoint( settings={ 'response_type': ([DeclarativeFilterView],), @@ -1444,6 +1487,54 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.set_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/layout/exportTemplates', + 'operation_id': 'set_export_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'declarative_export_templates', + ], + 'required': [ + 'declarative_export_templates', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'declarative_export_templates': + (DeclarativeExportTemplates,), + }, + 'attribute_map': { + }, + 'location_map': { + 'declarative_export_templates': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.set_filter_views_endpoint = _Endpoint( settings={ 'response_type': None, @@ -2386,6 +2477,84 @@ def get_data_sources_layout( kwargs['_request_auths'] = kwargs.get('_request_auths', None) return self.get_data_sources_layout_endpoint.call_with_http_info(**kwargs) + def get_export_templates_layout( + self, + **kwargs + ): + """Get all export templates layout # noqa: E501 + + Gets complete layout of export templates. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_export_templates_layout(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + DeclarativeExportTemplates + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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_export_templates_layout_endpoint.call_with_http_info(**kwargs) + def get_filter_views( self, workspace_id, @@ -4354,6 +4523,89 @@ def set_data_source_permissions( declarative_data_source_permissions return self.set_data_source_permissions_endpoint.call_with_http_info(**kwargs) + def set_export_templates( + self, + declarative_export_templates, + **kwargs + ): + """Set all export templates # noqa: E501 + + Sets export templates in 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.set_export_templates(declarative_export_templates, async_req=True) + >>> result = thread.get() + + Args: + declarative_export_templates (DeclarativeExportTemplates): + + 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['declarative_export_templates'] = \ + declarative_export_templates + return self.set_export_templates_endpoint.call_with_http_info(**kwargs) + def set_filter_views( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/notification_channels_api.py b/gooddata-api-client/gooddata_api_client/api/notification_channels_api.py index 332a0b574..89911d595 100644 --- a/gooddata-api-client/gooddata_api_client/api/notification_channels_api.py +++ b/gooddata-api-client/gooddata_api_client/api/notification_channels_api.py @@ -22,6 +22,7 @@ none_type, validate_and_convert_types ) +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels 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 @@ -294,6 +295,48 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_export_templates_layout_endpoint = _Endpoint( + settings={ + 'response_type': (DeclarativeExportTemplates,), + 'auth': [], + 'endpoint_path': '/api/v1/layout/exportTemplates', + 'operation_id': 'get_export_templates_layout', + '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.get_notification_channels_layout_endpoint = _Endpoint( settings={ 'response_type': (DeclarativeNotificationChannels,), @@ -582,6 +625,54 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.set_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/layout/exportTemplates', + 'operation_id': 'set_export_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'declarative_export_templates', + ], + 'required': [ + 'declarative_export_templates', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'declarative_export_templates': + (DeclarativeExportTemplates,), + }, + 'attribute_map': { + }, + 'location_map': { + 'declarative_export_templates': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.set_notification_channels_endpoint = _Endpoint( settings={ 'response_type': None, @@ -1134,6 +1225,84 @@ def get_entity_notification_channels( id return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + def get_export_templates_layout( + self, + **kwargs + ): + """Get all export templates layout # noqa: E501 + + Gets complete layout of export templates. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_export_templates_layout(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + DeclarativeExportTemplates + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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_export_templates_layout_endpoint.call_with_http_info(**kwargs) + def get_notification_channels_layout( self, **kwargs @@ -1544,6 +1713,89 @@ def patch_entity_notification_channels( json_api_notification_channel_patch_document return self.patch_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + def set_export_templates( + self, + declarative_export_templates, + **kwargs + ): + """Set all export templates # noqa: E501 + + Sets export templates in 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.set_export_templates(declarative_export_templates, async_req=True) + >>> result = thread.get() + + Args: + declarative_export_templates (DeclarativeExportTemplates): + + 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['declarative_export_templates'] = \ + declarative_export_templates + return self.set_export_templates_endpoint.call_with_http_info(**kwargs) + def set_notification_channels( self, declarative_notification_channels, 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 85b17f82e..0f4adfa60 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 @@ -38,6 +38,11 @@ from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList @@ -257,6 +262,56 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates', + 'operation_id': 'create_entity_export_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_export_template_post_optional_id_document', + ], + 'required': [ + 'json_api_export_template_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'json_api_export_template_post_optional_id_document': + (JsonApiExportTemplatePostOptionalIdDocument,), + }, + 'attribute_map': { + }, + 'location_map': { + 'json_api_export_template_post_optional_id_document': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.create_entity_identity_providers_endpoint = _Endpoint( settings={ 'response_type': (JsonApiIdentityProviderOutDocument,), @@ -942,6 +997,65 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'delete_entity_export_templates', + '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_identity_providers_endpoint = _Endpoint( settings={ 'response_type': None, @@ -1875,6 +1989,86 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates', + 'operation_id': 'get_all_entities_export_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_identity_providers_endpoint = _Endpoint( settings={ 'response_type': (JsonApiIdentityProviderOutList,), @@ -3056,6 +3250,67 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'get_entity_export_templates', + '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/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_entity_identity_providers_endpoint = _Endpoint( settings={ 'response_type': (JsonApiIdentityProviderOutDocument,), @@ -3928,24 +4183,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_identity_providers_endpoint = _Endpoint( + self.patch_entity_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), + 'response_type': (JsonApiExportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'patch_entity_identity_providers', + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'patch_entity_export_templates', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_identity_provider_patch_document', + 'json_api_export_template_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_identity_provider_patch_document', + 'json_api_export_template_patch_document', ], 'nullable': [ ], @@ -3969,8 +4224,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_identity_provider_patch_document': - (JsonApiIdentityProviderPatchDocument,), + 'json_api_export_template_patch_document': + (JsonApiExportTemplatePatchDocument,), 'filter': (str,), }, @@ -3980,7 +4235,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_identity_provider_patch_document': 'body', + 'json_api_export_template_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -3996,24 +4251,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_jwks_endpoint = _Endpoint( + self.patch_entity_identity_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiJwkOutDocument,), + 'response_type': (JsonApiIdentityProviderOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'patch_entity_jwks', + 'endpoint_path': '/api/v1/entities/identityProviders/{id}', + 'operation_id': 'patch_entity_identity_providers', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_jwk_patch_document', + 'json_api_identity_provider_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_jwk_patch_document', + 'json_api_identity_provider_patch_document', ], 'nullable': [ ], @@ -4037,8 +4292,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_jwk_patch_document': - (JsonApiJwkPatchDocument,), + 'json_api_identity_provider_patch_document': + (JsonApiIdentityProviderPatchDocument,), 'filter': (str,), }, @@ -4048,7 +4303,75 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_jwk_patch_document': 'body', + 'json_api_identity_provider_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.patch_entity_jwks_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiJwkOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/jwks/{id}', + 'operation_id': 'patch_entity_jwks', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_jwk_patch_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_jwk_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_jwk_patch_document': + (JsonApiJwkPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_jwk_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -4782,6 +5105,74 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'update_entity_export_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_export_template_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_export_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_export_template_in_document': + (JsonApiExportTemplateInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_export_template_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.update_entity_identity_providers_endpoint = _Endpoint( settings={ 'response_type': (JsonApiIdentityProviderOutDocument,), @@ -5682,6 +6073,88 @@ def create_entity_data_sources( json_api_data_source_in_document return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) + def create_entity_export_templates( + self, + json_api_export_template_post_optional_id_document, + **kwargs + ): + """Post Export Template entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_export_template_post_optional_id_document'] = \ + json_api_export_template_post_optional_id_document + return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def create_entity_identity_providers( self, json_api_identity_provider_in_document, @@ -6679,6 +7152,89 @@ def delete_entity_data_sources( id return self.delete_entity_data_sources_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_identity_providers( self, id, @@ -7646,7 +8202,90 @@ def get_all_entities_data_source_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceIdentifierOutList + JsonApiDataSourceIdentifierOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_data_sources( + self, + **kwargs + ): + """Get Data Source entities # noqa: E501 + + Data Source - represents data source for the workspace # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_data_sources(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: + JsonApiDataSourceOutList If the method is called asynchronously, returns the request thread. """ @@ -7675,19 +8314,19 @@ def get_all_entities_data_source_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_sources( + def get_all_entities_entitlements( self, **kwargs ): - """Get Data Source entities # noqa: E501 + """Get Entitlements # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_data_sources(async_req=True) + >>> thread = api.get_all_entities_entitlements(async_req=True) >>> result = thread.get() @@ -7729,7 +8368,7 @@ def get_all_entities_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutList + JsonApiEntitlementOutList If the method is called asynchronously, returns the request thread. """ @@ -7758,19 +8397,18 @@ def get_all_entities_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) - def get_all_entities_entitlements( + def get_all_entities_export_templates( self, **kwargs ): - """Get Entitlements # noqa: E501 + """GET all Export Template entities # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_entitlements(async_req=True) + >>> thread = api.get_all_entities_export_templates(async_req=True) >>> result = thread.get() @@ -7812,7 +8450,7 @@ def get_all_entities_entitlements( async_req (bool): execute request asynchronously Returns: - JsonApiEntitlementOutList + JsonApiExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -7841,7 +8479,7 @@ def get_all_entities_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) def get_all_entities_identity_providers( self, @@ -9091,6 +9729,89 @@ def get_entity_entitlements( id return self.get_entity_entitlements_endpoint.call_with_http_info(**kwargs) + def get_entity_export_templates( + self, + id, + **kwargs + ): + """GET Export Template entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_export_templates(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def get_entity_identity_providers( self, id, @@ -10193,6 +10914,93 @@ def patch_entity_data_sources( json_api_data_source_patch_document return self.patch_entity_data_sources_endpoint.call_with_http_info(**kwargs) + def patch_entity_export_templates( + self, + id, + json_api_export_template_patch_document, + **kwargs + ): + """Patch Export Template entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_export_template_patch_document'] = \ + json_api_export_template_patch_document + return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def patch_entity_identity_providers( self, id, @@ -11246,6 +12054,93 @@ def update_entity_data_sources( json_api_data_source_in_document return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) + def update_entity_export_templates( + self, + id, + json_api_export_template_in_document, + **kwargs + ): + """PUT Export Template entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_export_template_in_document (JsonApiExportTemplateInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_export_template_in_document'] = \ + json_api_export_template_in_document + return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def update_entity_identity_providers( self, id, diff --git a/gooddata-api-client/gooddata_api_client/api/slideshow_export_api.py b/gooddata-api-client/gooddata_api_client/api/slides_export_api.py similarity index 99% rename from gooddata-api-client/gooddata_api_client/api/slideshow_export_api.py rename to gooddata-api-client/gooddata_api_client/api/slides_export_api.py index 91cb31453..34f0bb56b 100644 --- a/gooddata-api-client/gooddata_api_client/api/slideshow_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/slides_export_api.py @@ -23,10 +23,11 @@ validate_and_convert_types ) from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.get_slides_export202_response_inner import GetSlidesExport202ResponseInner from gooddata_api_client.model.slides_export_request import SlidesExportRequest -class SlideshowExportApi(object): +class SlidesExportApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/gooddata-api-client/gooddata_api_client/apis/__init__.py b/gooddata-api-client/gooddata_api_client/apis/__init__.py index 6a6d80788..816f9bd5e 100644 --- a/gooddata-api-client/gooddata_api_client/apis/__init__.py +++ b/gooddata-api-client/gooddata_api_client/apis/__init__.py @@ -56,7 +56,7 @@ from gooddata_api_client.api.raw_export_api import RawExportApi from gooddata_api_client.api.reporting_settings_api import ReportingSettingsApi from gooddata_api_client.api.scanning_api import ScanningApi -from gooddata_api_client.api.slideshow_export_api import SlideshowExportApi +from gooddata_api_client.api.slides_export_api import SlidesExportApi from gooddata_api_client.api.smart_functions_api import SmartFunctionsApi from gooddata_api_client.api.tabular_export_api import TabularExportApi from gooddata_api_client.api.test_connection_api import TestConnectionApi diff --git a/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.py b/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.py index f6c470b3a..443e93901 100644 --- a/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.py +++ b/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.py @@ -32,19 +32,19 @@ def lazy_import(): from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient + from gooddata_api_client.model.automation_metadata import AutomationMetadata 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 - from gooddata_api_client.model.json_node import JsonNode globals()['AutomationExternalRecipient'] = AutomationExternalRecipient + globals()['AutomationMetadata'] = AutomationMetadata globals()['AutomationTabularExport'] = AutomationTabularExport globals()['AutomationVisualExport'] = AutomationVisualExport globals()['DeclarativeAnalyticalDashboardIdentifier'] = DeclarativeAnalyticalDashboardIdentifier globals()['DeclarativeNotificationChannelIdentifier'] = DeclarativeNotificationChannelIdentifier globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - globals()['JsonNode'] = JsonNode class AdHocAutomation(ModelNormal): @@ -122,7 +122,7 @@ def openapi_types(): 'description': (str,), # noqa: E501 'details': ({str: (str,)},), # noqa: E501 'external_recipients': ([AutomationExternalRecipient],), # noqa: E501 - 'metadata': (JsonNode,), # noqa: E501 + 'metadata': (AutomationMetadata,), # noqa: E501 'notification_channel': (DeclarativeNotificationChannelIdentifier,), # noqa: E501 'recipients': ([DeclarativeUserIdentifier],), # noqa: E501 'tabular_exports': ([AutomationTabularExport],), # noqa: E501 @@ -195,7 +195,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 description (str): [optional] # noqa: E501 details ({str: (str,)}): Additional details to be included in the automated message.. [optional] # noqa: E501 external_recipients ([AutomationExternalRecipient]): External recipients of the automation action results.. [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 + metadata (AutomationMetadata): [optional] # noqa: E501 notification_channel (DeclarativeNotificationChannelIdentifier): [optional] # noqa: E501 recipients ([DeclarativeUserIdentifier]): [optional] # noqa: E501 tabular_exports ([AutomationTabularExport]): [optional] # noqa: E501 @@ -291,7 +291,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 description (str): [optional] # noqa: E501 details ({str: (str,)}): Additional details to be included in the automated message.. [optional] # noqa: E501 external_recipients ([AutomationExternalRecipient]): External recipients of the automation action results.. [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 + metadata (AutomationMetadata): [optional] # noqa: E501 notification_channel (DeclarativeNotificationChannelIdentifier): [optional] # noqa: E501 recipients ([DeclarativeUserIdentifier]): [optional] # noqa: E501 tabular_exports ([AutomationTabularExport]): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.py b/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.py new file mode 100644 index 000000000..fa33499f2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.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 AfmCancelTokens(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'token_ids': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'token_ids': 'tokenIds', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, token_ids, *args, **kwargs): # noqa: E501 + """AfmCancelTokens - a model defined in OpenAPI + + Args: + token_ids ([str]): Token ids to be used in the cancellation. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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.token_ids = token_ids + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, token_ids, *args, **kwargs): # noqa: E501 + """AfmCancelTokens - a model defined in OpenAPI + + Args: + token_ids ([str]): Token ids to be used in the cancellation. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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.token_ids = token_ids + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/api_entitlement.py b/gooddata-api-client/gooddata_api_client/model/api_entitlement.py index d5673984c..09f2e604e 100644 --- a/gooddata-api-client/gooddata_api_client/model/api_entitlement.py +++ b/gooddata-api-client/gooddata_api_client/model/api_entitlement.py @@ -82,6 +82,7 @@ class ApiEntitlement(ModelNormal): 'UNLIMITEDDAILYALERTACTIONS': "UnlimitedDailyAlertActions", 'SCHEDULEDACTIONMINIMUMRECURRENCEMINUTES': "ScheduledActionMinimumRecurrenceMinutes", 'FEDERATEDIDENTITYMANAGEMENT': "FederatedIdentityManagement", + 'AUDITLOGGING': "AuditLogging", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/automation_metadata.py b/gooddata-api-client/gooddata_api_client/model/automation_metadata.py new file mode 100644 index 000000000..126e12971 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_metadata.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.visible_filter import VisibleFilter + globals()['VisibleFilter'] = VisibleFilter + + +class AutomationMetadata(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 = { + ('value',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'visible_filters': ([VisibleFilter],), # noqa: E501 + 'widget': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'visible_filters': 'visibleFilters', # noqa: E501 + 'widget': 'widget', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AutomationMetadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + visible_filters ([VisibleFilter]): [optional] # noqa: E501 + widget (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 + """AutomationMetadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + visible_filters ([VisibleFilter]): [optional] # noqa: E501 + widget (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/content_slide_template.py b/gooddata-api-client/gooddata_api_client/model/content_slide_template.py new file mode 100644 index 000000000..b9f27b395 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/content_slide_template.py @@ -0,0 +1,278 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.running_section import RunningSection + globals()['RunningSection'] = RunningSection + + +class ContentSlideTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'description_field': (str, none_type,), # noqa: E501 + 'footer': (RunningSection,), # noqa: E501 + 'header': (RunningSection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description_field': 'descriptionField', # noqa: E501 + 'footer': 'footer', # noqa: E501 + 'header': 'header', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ContentSlideTemplate - 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_field (str, none_type): [optional] # noqa: E501 + footer (RunningSection): [optional] # noqa: E501 + header (RunningSection): [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 + """ContentSlideTemplate - 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_field (str, none_type): [optional] # noqa: E501 + footer (RunningSection): [optional] # noqa: E501 + header (RunningSection): [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/cover_slide_template.py b/gooddata-api-client/gooddata_api_client/model/cover_slide_template.py new file mode 100644 index 000000000..2e2407a74 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/cover_slide_template.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.running_section import RunningSection + globals()['RunningSection'] = RunningSection + + +class CoverSlideTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'background_image': (bool,), # noqa: E501 + 'description_field': (str, none_type,), # noqa: E501 + 'footer': (RunningSection,), # noqa: E501 + 'header': (RunningSection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_image': 'backgroundImage', # noqa: E501 + 'description_field': 'descriptionField', # noqa: E501 + 'footer': 'footer', # noqa: E501 + 'header': 'header', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CoverSlideTemplate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 + description_field (str, none_type): [optional] # noqa: E501 + footer (RunningSection): [optional] # noqa: E501 + header (RunningSection): [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 + """CoverSlideTemplate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 + description_field (str, none_type): [optional] # noqa: E501 + footer (RunningSection): [optional] # noqa: E501 + header (RunningSection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.py b/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.py new file mode 100644 index 000000000..4a41bc0fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.py @@ -0,0 +1,305 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.content_slide_template import ContentSlideTemplate + from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate + from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate + from gooddata_api_client.model.section_slide_template import SectionSlideTemplate + globals()['ContentSlideTemplate'] = ContentSlideTemplate + globals()['CoverSlideTemplate'] = CoverSlideTemplate + globals()['IntroSlideTemplate'] = IntroSlideTemplate + globals()['SectionSlideTemplate'] = SectionSlideTemplate + + +class DashboardSlidesTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('applied_on',): { + 'PDF': "PDF", + 'PPTX': "PPTX", + }, + } + + validations = { + ('applied_on',): { + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'applied_on': ([str],), # noqa: E501 + 'content_slide': (ContentSlideTemplate,), # noqa: E501 + 'cover_slide': (CoverSlideTemplate,), # noqa: E501 + 'intro_slide': (IntroSlideTemplate,), # noqa: E501 + 'section_slide': (SectionSlideTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'applied_on': 'appliedOn', # noqa: E501 + 'content_slide': 'contentSlide', # noqa: E501 + 'cover_slide': 'coverSlide', # noqa: E501 + 'intro_slide': 'introSlide', # noqa: E501 + 'section_slide': 'sectionSlide', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 + """DashboardSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + cover_slide (CoverSlideTemplate): [optional] # noqa: E501 + intro_slide (IntroSlideTemplate): [optional] # noqa: E501 + section_slide (SectionSlideTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.applied_on = applied_on + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, applied_on, *args, **kwargs): # noqa: E501 + """DashboardSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + cover_slide (CoverSlideTemplate): [optional] # noqa: E501 + intro_slide (IntroSlideTemplate): [optional] # noqa: E501 + section_slide (SectionSlideTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.applied_on = applied_on + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_automation.py b/gooddata-api-client/gooddata_api_client/model/declarative_automation.py index 1b9f14787..231e5de01 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_automation.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_automation.py @@ -33,6 +33,7 @@ def lazy_import(): from gooddata_api_client.model.automation_alert import AutomationAlert from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient + from gooddata_api_client.model.automation_metadata import AutomationMetadata from gooddata_api_client.model.automation_schedule import AutomationSchedule from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport from gooddata_api_client.model.automation_visual_export import AutomationVisualExport @@ -40,9 +41,9 @@ def lazy_import(): 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 - from gooddata_api_client.model.json_node import JsonNode globals()['AutomationAlert'] = AutomationAlert globals()['AutomationExternalRecipient'] = AutomationExternalRecipient + globals()['AutomationMetadata'] = AutomationMetadata globals()['AutomationSchedule'] = AutomationSchedule globals()['AutomationTabularExport'] = AutomationTabularExport globals()['AutomationVisualExport'] = AutomationVisualExport @@ -50,7 +51,6 @@ def lazy_import(): globals()['DeclarativeExportDefinitionIdentifier'] = DeclarativeExportDefinitionIdentifier globals()['DeclarativeNotificationChannelIdentifier'] = DeclarativeNotificationChannelIdentifier globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier - globals()['JsonNode'] = JsonNode class DeclarativeAutomation(ModelNormal): @@ -154,7 +154,7 @@ def openapi_types(): 'details': ({str: (str,)},), # noqa: E501 'export_definitions': ([DeclarativeExportDefinitionIdentifier],), # noqa: E501 'external_recipients': ([AutomationExternalRecipient],), # noqa: E501 - 'metadata': (JsonNode,), # noqa: E501 + 'metadata': (AutomationMetadata,), # noqa: E501 'modified_at': (str, none_type,), # noqa: E501 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 'notification_channel': (DeclarativeNotificationChannelIdentifier,), # noqa: E501 @@ -247,7 +247,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 details ({str: (str,)}): TODO. [optional] # noqa: E501 export_definitions ([DeclarativeExportDefinitionIdentifier]): [optional] # noqa: E501 external_recipients ([AutomationExternalRecipient]): External recipients of the automation action results.. [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 + metadata (AutomationMetadata): [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 notification_channel (DeclarativeNotificationChannelIdentifier): [optional] # noqa: E501 @@ -355,7 +355,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 details ({str: (str,)}): TODO. [optional] # noqa: E501 export_definitions ([DeclarativeExportDefinitionIdentifier]): [optional] # noqa: E501 external_recipients ([AutomationExternalRecipient]): External recipients of the automation action results.. [optional] # noqa: E501 - metadata (JsonNode): [optional] # noqa: E501 + metadata (AutomationMetadata): [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 notification_channel (DeclarativeNotificationChannelIdentifier): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_template.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_template.py new file mode 100644 index 000000000..60e91bbe9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_export_template.py @@ -0,0 +1,300 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.dashboard_slides_template import DashboardSlidesTemplate + from gooddata_api_client.model.widget_slides_template import WidgetSlidesTemplate + globals()['DashboardSlidesTemplate'] = DashboardSlidesTemplate + globals()['WidgetSlidesTemplate'] = WidgetSlidesTemplate + + +class DeclarativeExportTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('name',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'dashboard_slides_template': (DashboardSlidesTemplate,), # noqa: E501 + 'widget_slides_template': (WidgetSlidesTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 + 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 + """DeclarativeExportTemplate - a model defined in OpenAPI + + Args: + id (str): Identifier of an export template + name (str): Name of an export template. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dashboard_slides_template (DashboardSlidesTemplate): [optional] # noqa: E501 + widget_slides_template (WidgetSlidesTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, name, *args, **kwargs): # noqa: E501 + """DeclarativeExportTemplate - a model defined in OpenAPI + + Args: + id (str): Identifier of an export template + name (str): Name of an export template. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dashboard_slides_template (DashboardSlidesTemplate): [optional] # noqa: E501 + widget_slides_template (WidgetSlidesTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.py new file mode 100644 index 000000000..db3e3d55d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.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.declarative_export_template import DeclarativeExportTemplate + globals()['DeclarativeExportTemplate'] = DeclarativeExportTemplate + + +class DeclarativeExportTemplates(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'export_templates': ([DeclarativeExportTemplate],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'export_templates': 'exportTemplates', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, export_templates, *args, **kwargs): # noqa: E501 + """DeclarativeExportTemplates - a model defined in OpenAPI + + Args: + export_templates ([DeclarativeExportTemplate]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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.export_templates = export_templates + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, export_templates, *args, **kwargs): # noqa: E501 + """DeclarativeExportTemplates - a model defined in OpenAPI + + Args: + export_templates ([DeclarativeExportTemplate]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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.export_templates = export_templates + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization.py b/gooddata-api-client/gooddata_api_client/model/declarative_organization.py index 2d36ae2b1..37c34fced 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_organization.py @@ -32,6 +32,7 @@ def lazy_import(): from gooddata_api_client.model.declarative_data_source import DeclarativeDataSource + from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider from gooddata_api_client.model.declarative_jwk import DeclarativeJwk from gooddata_api_client.model.declarative_notification_channel import DeclarativeNotificationChannel @@ -41,6 +42,7 @@ def lazy_import(): from gooddata_api_client.model.declarative_workspace import DeclarativeWorkspace from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter globals()['DeclarativeDataSource'] = DeclarativeDataSource + globals()['DeclarativeExportTemplate'] = DeclarativeExportTemplate globals()['DeclarativeIdentityProvider'] = DeclarativeIdentityProvider globals()['DeclarativeJwk'] = DeclarativeJwk globals()['DeclarativeNotificationChannel'] = DeclarativeNotificationChannel @@ -106,6 +108,7 @@ def openapi_types(): return { 'organization': (DeclarativeOrganizationInfo,), # noqa: E501 'data_sources': ([DeclarativeDataSource],), # noqa: E501 + 'export_templates': ([DeclarativeExportTemplate],), # noqa: E501 'identity_providers': ([DeclarativeIdentityProvider],), # noqa: E501 'jwks': ([DeclarativeJwk],), # noqa: E501 'notification_channels': ([DeclarativeNotificationChannel],), # noqa: E501 @@ -123,6 +126,7 @@ def discriminator(): attribute_map = { 'organization': 'organization', # noqa: E501 'data_sources': 'dataSources', # noqa: E501 + 'export_templates': 'exportTemplates', # noqa: E501 'identity_providers': 'identityProviders', # noqa: E501 'jwks': 'jwks', # noqa: E501 'notification_channels': 'notificationChannels', # noqa: E501 @@ -177,6 +181,7 @@ def _from_openapi_data(cls, organization, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) data_sources ([DeclarativeDataSource]): [optional] # noqa: E501 + export_templates ([DeclarativeExportTemplate]): [optional] # noqa: E501 identity_providers ([DeclarativeIdentityProvider]): [optional] # noqa: E501 jwks ([DeclarativeJwk]): [optional] # noqa: E501 notification_channels ([DeclarativeNotificationChannel]): [optional] # noqa: E501 @@ -274,6 +279,7 @@ def __init__(self, organization, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) data_sources ([DeclarativeDataSource]): [optional] # noqa: E501 + export_templates ([DeclarativeExportTemplate]): [optional] # noqa: E501 identity_providers ([DeclarativeIdentityProvider]): [optional] # noqa: E501 jwks ([DeclarativeJwk]): [optional] # noqa: E501 notification_channels ([DeclarativeNotificationChannel]): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py b/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py index 4da9cb810..cb254c21f 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py @@ -141,6 +141,7 @@ def openapi_types(): 'oauth_client_id': (str,), # noqa: E501 'oauth_client_secret': (str,), # noqa: E501 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 + 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 'oauth_issuer_id': (str,), # noqa: E501 'oauth_issuer_location': (str,), # noqa: E501 'oauth_subject_id_claim': (str,), # noqa: E501 @@ -166,6 +167,7 @@ def discriminator(): 'oauth_client_id': 'oauthClientId', # noqa: E501 'oauth_client_secret': 'oauthClientSecret', # noqa: E501 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 + 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 @@ -228,6 +230,7 @@ def _from_openapi_data(cls, hostname, id, name, permissions, *args, **kwargs): oauth_client_id (str): Identifier of the authentication provider. [optional] # noqa: E501 oauth_client_secret (str): Communication secret of the authentication provider (never returned back).. [optional] # noqa: E501 oauth_custom_auth_attributes ({str: (str,)}): 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] # noqa: E501 + oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 oauth_issuer_id (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] # noqa: E501 oauth_issuer_location (str): URI of the authentication provider.. [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 @@ -336,6 +339,7 @@ def __init__(self, hostname, id, name, permissions, *args, **kwargs): # noqa: E oauth_client_id (str): Identifier of the authentication provider. [optional] # noqa: E501 oauth_client_secret (str): Communication secret of the authentication provider (never returned back).. [optional] # noqa: E501 oauth_custom_auth_attributes ({str: (str,)}): 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] # noqa: E501 + oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 oauth_issuer_id (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] # noqa: E501 oauth_issuer_location (str): URI of the authentication provider.. [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py index 7187e653f..87d7e0e03 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py @@ -80,6 +80,7 @@ class DeclarativeSetting(ModelNormal): 'DATE_FILTER_CONFIG': "DATE_FILTER_CONFIG", 'JIT_PROVISIONING': "JIT_PROVISIONING", 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", + 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/entitlements_request.py b/gooddata-api-client/gooddata_api_client/model/entitlements_request.py index 0295ef837..b1ddd8db0 100644 --- a/gooddata-api-client/gooddata_api_client/model/entitlements_request.py +++ b/gooddata-api-client/gooddata_api_client/model/entitlements_request.py @@ -82,6 +82,7 @@ class EntitlementsRequest(ModelNormal): 'UNLIMITEDDAILYALERTACTIONS': "UnlimitedDailyAlertActions", 'SCHEDULEDACTIONMINIMUMRECURRENCEMINUTES': "ScheduledActionMinimumRecurrenceMinutes", 'FEDERATEDIDENTITYMANAGEMENT': "FederatedIdentityManagement", + 'AUDITLOGGING': "AuditLogging", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/execution_settings.py b/gooddata-api-client/gooddata_api_client/model/execution_settings.py index 1e5556837..b7daddc02 100644 --- a/gooddata-api-client/gooddata_api_client/model/execution_settings.py +++ b/gooddata-api-client/gooddata_api_client/model/execution_settings.py @@ -87,6 +87,7 @@ def openapi_types(): """ return { 'data_sampling_percentage': (float,), # noqa: E501 + 'timestamp': (datetime,), # noqa: E501 } @cached_property @@ -96,6 +97,7 @@ def discriminator(): attribute_map = { 'data_sampling_percentage': 'dataSamplingPercentage', # noqa: E501 + 'timestamp': 'timestamp', # noqa: E501 } read_only_vars = { @@ -140,6 +142,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) data_sampling_percentage (float): Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.. [optional] # noqa: E501 + timestamp (datetime): Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -226,6 +229,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) data_sampling_percentage (float): Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.. [optional] # noqa: E501 + timestamp (datetime): Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/get_slides_export202_response_inner.py b/gooddata-api-client/gooddata_api_client/model/get_slides_export202_response_inner.py new file mode 100644 index 000000000..a7bfeb09f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/get_slides_export202_response_inner.py @@ -0,0 +1,292 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class GetSlidesExport202ResponseInner(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'char': (str,), # noqa: E501 + 'direct': (bool,), # noqa: E501 + 'double': (float,), # noqa: E501 + 'float': (float,), # noqa: E501 + 'int': (int,), # noqa: E501 + 'long': (int,), # noqa: E501 + 'read_only': (bool,), # noqa: E501 + 'short': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'char': 'char', # noqa: E501 + 'direct': 'direct', # noqa: E501 + 'double': 'double', # noqa: E501 + 'float': 'float', # noqa: E501 + 'int': 'int', # noqa: E501 + 'long': 'long', # noqa: E501 + 'read_only': 'readOnly', # noqa: E501 + 'short': 'short', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GetSlidesExport202ResponseInner - 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,) + char (str): [optional] # noqa: E501 + direct (bool): [optional] # noqa: E501 + double (float): [optional] # noqa: E501 + float (float): [optional] # noqa: E501 + int (int): [optional] # noqa: E501 + long (int): [optional] # noqa: E501 + read_only (bool): [optional] # noqa: E501 + short (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GetSlidesExport202ResponseInner - 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,) + char (str): [optional] # noqa: E501 + direct (bool): [optional] # noqa: E501 + double (float): [optional] # noqa: E501 + float (float): [optional] # noqa: E501 + int (int): [optional] # noqa: E501 + long (int): [optional] # noqa: E501 + read_only (bool): [optional] # noqa: E501 + short (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/intro_slide_template.py b/gooddata-api-client/gooddata_api_client/model/intro_slide_template.py new file mode 100644 index 000000000..aceb77df0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/intro_slide_template.py @@ -0,0 +1,286 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.running_section import RunningSection + globals()['RunningSection'] = RunningSection + + +class IntroSlideTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'background_image': (bool,), # noqa: E501 + 'description_field': (str, none_type,), # noqa: E501 + 'footer': (RunningSection,), # noqa: E501 + 'header': (RunningSection,), # noqa: E501 + 'title_field': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_image': 'backgroundImage', # noqa: E501 + 'description_field': 'descriptionField', # noqa: E501 + 'footer': 'footer', # noqa: E501 + 'header': 'header', # noqa: E501 + 'title_field': 'titleField', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """IntroSlideTemplate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 + description_field (str, none_type): [optional] # noqa: E501 + footer (RunningSection): [optional] # noqa: E501 + header (RunningSection): [optional] # noqa: E501 + title_field (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """IntroSlideTemplate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 + description_field (str, none_type): [optional] # noqa: E501 + footer (RunningSection): [optional] # noqa: E501 + header (RunningSection): [optional] # noqa: E501 + title_field (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py index 17535c3a4..d42288122 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py @@ -33,11 +33,13 @@ def lazy_import(): from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert from gooddata_api_client.model.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner + from gooddata_api_client.model.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner globals()['JsonApiAutomationInAttributesAlert'] = JsonApiAutomationInAttributesAlert globals()['JsonApiAutomationInAttributesExternalRecipientsInner'] = JsonApiAutomationInAttributesExternalRecipientsInner + globals()['JsonApiAutomationInAttributesMetadata'] = JsonApiAutomationInAttributesMetadata globals()['JsonApiAutomationInAttributesSchedule'] = JsonApiAutomationInAttributesSchedule globals()['JsonApiAutomationInAttributesTabularExportsInner'] = JsonApiAutomationInAttributesTabularExportsInner globals()['JsonApiAutomationInAttributesVisualExportsInner'] = JsonApiAutomationInAttributesVisualExportsInner @@ -81,8 +83,6 @@ class JsonApiAutomationInAttributes(ModelNormal): ('details',): { 'max_length': 10000, }, - ('metadata',): { - }, ('title',): { 'max_length': 255, }, @@ -116,7 +116,7 @@ def openapi_types(): 'description': (str,), # noqa: E501 'details': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 'external_recipients': ([JsonApiAutomationInAttributesExternalRecipientsInner],), # noqa: E501 - 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'metadata': (JsonApiAutomationInAttributesMetadata,), # noqa: E501 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 'state': (str,), # noqa: E501 'tabular_exports': ([JsonApiAutomationInAttributesTabularExportsInner],), # noqa: E501 @@ -191,7 +191,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 description (str): [optional] # noqa: E501 details (bool, date, datetime, dict, float, int, list, str, none_type): Additional details to be included in the automated message.. [optional] # noqa: E501 external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Additional information for the automation.. [optional] # noqa: E501 + metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] # noqa: E501 tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 @@ -288,7 +288,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 description (str): [optional] # noqa: E501 details (bool, date, datetime, dict, float, int, list, str, none_type): Additional details to be included in the automated message.. [optional] # noqa: E501 external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Additional information for the automation.. [optional] # noqa: E501 + metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] # noqa: E501 tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_metadata.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_metadata.py new file mode 100644 index 000000000..61e1fdf3b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_metadata.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.visible_filter import VisibleFilter + globals()['VisibleFilter'] = VisibleFilter + + +class JsonApiAutomationInAttributesMetadata(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 = { + ('value',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'visible_filters': ([VisibleFilter],), # noqa: E501 + 'widget': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'visible_filters': 'visibleFilters', # noqa: E501 + 'widget': 'widget', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiAutomationInAttributesMetadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + visible_filters ([VisibleFilter]): [optional] # noqa: E501 + widget (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 + """JsonApiAutomationInAttributesMetadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + visible_filters ([VisibleFilter]): [optional] # noqa: E501 + widget (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py index 1c5724f58..a9a5005fc 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py @@ -33,11 +33,13 @@ def lazy_import(): from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert from gooddata_api_client.model.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner + from gooddata_api_client.model.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner globals()['JsonApiAutomationInAttributesAlert'] = JsonApiAutomationInAttributesAlert globals()['JsonApiAutomationInAttributesExternalRecipientsInner'] = JsonApiAutomationInAttributesExternalRecipientsInner + globals()['JsonApiAutomationInAttributesMetadata'] = JsonApiAutomationInAttributesMetadata globals()['JsonApiAutomationInAttributesSchedule'] = JsonApiAutomationInAttributesSchedule globals()['JsonApiAutomationInAttributesTabularExportsInner'] = JsonApiAutomationInAttributesTabularExportsInner globals()['JsonApiAutomationInAttributesVisualExportsInner'] = JsonApiAutomationInAttributesVisualExportsInner @@ -81,8 +83,6 @@ class JsonApiAutomationOutAttributes(ModelNormal): ('details',): { 'max_length': 10000, }, - ('metadata',): { - }, ('title',): { 'max_length': 255, }, @@ -117,7 +117,7 @@ def openapi_types(): 'description': (str,), # noqa: E501 'details': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 'external_recipients': ([JsonApiAutomationInAttributesExternalRecipientsInner],), # noqa: E501 - 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'metadata': (JsonApiAutomationInAttributesMetadata,), # noqa: E501 'modified_at': (datetime,), # noqa: E501 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 'state': (str,), # noqa: E501 @@ -196,7 +196,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 description (str): [optional] # noqa: E501 details (bool, date, datetime, dict, float, int, list, str, none_type): Additional details to be included in the automated message.. [optional] # noqa: E501 external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Additional information for the automation.. [optional] # noqa: E501 + metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 modified_at (datetime): [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] # noqa: E501 @@ -295,7 +295,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 description (str): [optional] # noqa: E501 details (bool, date, datetime, dict, float, int, list, str, none_type): Additional details to be included in the automated message.. [optional] # noqa: E501 external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Additional information for the automation.. [optional] # noqa: E501 + metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 modified_at (datetime): [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py index add764129..b0d2e116e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py @@ -91,6 +91,7 @@ class JsonApiDataSourceOutAttributes(ModelNormal): 'TOKEN': "TOKEN", 'KEY_PAIR': "KEY_PAIR", 'CLIENT_SECRET': "CLIENT_SECRET", + 'ACCESS_TOKEN': "ACCESS_TOKEN", }, ('cache_strategy',): { 'None': None, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.py new file mode 100644 index 000000000..409962041 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.py @@ -0,0 +1,298 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes + globals()['JsonApiExportTemplateInAttributes'] = JsonApiExportTemplateInAttributes + + +class JsonApiExportTemplateIn(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'EXPORTTEMPLATE': "exportTemplate", + }, + } + + 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': (JsonApiExportTemplateInAttributes,), # 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 + """JsonApiExportTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiExportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # 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', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + """JsonApiExportTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiExportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # 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', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_export_template_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes.py new file mode 100644 index 000000000..076631ef4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes.py @@ -0,0 +1,289 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate + from gooddata_api_client.model.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate + globals()['JsonApiExportTemplateInAttributesDashboardSlidesTemplate'] = JsonApiExportTemplateInAttributesDashboardSlidesTemplate + globals()['JsonApiExportTemplateInAttributesWidgetSlidesTemplate'] = JsonApiExportTemplateInAttributesWidgetSlidesTemplate + + +class JsonApiExportTemplateInAttributes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'dashboard_slides_template': (JsonApiExportTemplateInAttributesDashboardSlidesTemplate,), # noqa: E501 + 'widget_slides_template': (JsonApiExportTemplateInAttributesWidgetSlidesTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 + 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplateInAttributes - a model defined in OpenAPI + + Args: + name (str): User-facing name of the Slides template. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dashboard_slides_template (JsonApiExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 + widget_slides_template (JsonApiExportTemplateInAttributesWidgetSlidesTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplateInAttributes - a model defined in OpenAPI + + Args: + name (str): User-facing name of the Slides template. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dashboard_slides_template (JsonApiExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 + widget_slides_template (JsonApiExportTemplateInAttributesWidgetSlidesTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py new file mode 100644 index 000000000..7eac8f33e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_dashboard_slides_template.py @@ -0,0 +1,305 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.content_slide_template import ContentSlideTemplate + from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate + from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate + from gooddata_api_client.model.section_slide_template import SectionSlideTemplate + globals()['ContentSlideTemplate'] = ContentSlideTemplate + globals()['CoverSlideTemplate'] = CoverSlideTemplate + globals()['IntroSlideTemplate'] = IntroSlideTemplate + globals()['SectionSlideTemplate'] = SectionSlideTemplate + + +class JsonApiExportTemplateInAttributesDashboardSlidesTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('applied_on',): { + 'PDF': "PDF", + 'PPTX': "PPTX", + }, + } + + validations = { + ('applied_on',): { + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'applied_on': ([str],), # noqa: E501 + 'content_slide': (ContentSlideTemplate,), # noqa: E501 + 'cover_slide': (CoverSlideTemplate,), # noqa: E501 + 'intro_slide': (IntroSlideTemplate,), # noqa: E501 + 'section_slide': (SectionSlideTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'applied_on': 'appliedOn', # noqa: E501 + 'content_slide': 'contentSlide', # noqa: E501 + 'cover_slide': 'coverSlide', # noqa: E501 + 'intro_slide': 'introSlide', # noqa: E501 + 'section_slide': 'sectionSlide', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplateInAttributesDashboardSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + cover_slide (CoverSlideTemplate): [optional] # noqa: E501 + intro_slide (IntroSlideTemplate): [optional] # noqa: E501 + section_slide (SectionSlideTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.applied_on = applied_on + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, applied_on, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplateInAttributesDashboardSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + cover_slide (CoverSlideTemplate): [optional] # noqa: E501 + intro_slide (IntroSlideTemplate): [optional] # noqa: E501 + section_slide (SectionSlideTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.applied_on = applied_on + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py new file mode 100644 index 000000000..c8b291bcc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_attributes_widget_slides_template.py @@ -0,0 +1,287 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.content_slide_template import ContentSlideTemplate + globals()['ContentSlideTemplate'] = ContentSlideTemplate + + +class JsonApiExportTemplateInAttributesWidgetSlidesTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('applied_on',): { + 'PDF': "PDF", + 'PPTX': "PPTX", + }, + } + + validations = { + ('applied_on',): { + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'applied_on': ([str],), # noqa: E501 + 'content_slide': (ContentSlideTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'applied_on': 'appliedOn', # noqa: E501 + 'content_slide': 'contentSlide', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplateInAttributesWidgetSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.applied_on = applied_on + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, applied_on, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplateInAttributesWidgetSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.applied_on = applied_on + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.py new file mode 100644 index 000000000..f9f6af75a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_in import JsonApiExportTemplateIn + globals()['JsonApiExportTemplateIn'] = JsonApiExportTemplateIn + + +class JsonApiExportTemplateInDocument(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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': (JsonApiExportTemplateIn,), # 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 + """JsonApiExportTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiExportTemplateIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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 + """JsonApiExportTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiExportTemplateIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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_export_template_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out.py new file mode 100644 index 000000000..fd5b37d8c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_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_export_template_in_attributes import JsonApiExportTemplateInAttributes + globals()['JsonApiExportTemplateInAttributes'] = JsonApiExportTemplateInAttributes + + +class JsonApiExportTemplateOut(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'EXPORTTEMPLATE': "exportTemplate", + }, + } + + 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': (JsonApiExportTemplateInAttributes,), # 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 + """JsonApiExportTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiExportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # 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', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + """JsonApiExportTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiExportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # 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', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_export_template_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.py new file mode 100644 index 000000000..118649bc9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_out import JsonApiExportTemplateOut + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiExportTemplateOut'] = JsonApiExportTemplateOut + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiExportTemplateOutDocument(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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': (JsonApiExportTemplateOut,), # 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 + """JsonApiExportTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiExportTemplateOut): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiExportTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiExportTemplateOut): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_export_template_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py new file mode 100644 index 000000000..107702eb5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py @@ -0,0 +1,290 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_analytical_dashboard_out_list_meta import JsonApiAnalyticalDashboardOutListMeta + from gooddata_api_client.model.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAnalyticalDashboardOutListMeta'] = JsonApiAnalyticalDashboardOutListMeta + globals()['JsonApiExportTemplateOutWithLinks'] = JsonApiExportTemplateOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiExportTemplateOutList(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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': ([JsonApiExportTemplateOutWithLinks],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAnalyticalDashboardOutListMeta,), # 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 + """JsonApiExportTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiExportTemplateOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 (JsonApiAnalyticalDashboardOutListMeta): [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 + """JsonApiExportTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiExportTemplateOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 (JsonApiAnalyticalDashboardOutListMeta): [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_export_template_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_with_links.py new file mode 100644 index 000000000..624440082 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_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_export_template_in_attributes import JsonApiExportTemplateInAttributes + from gooddata_api_client.model.json_api_export_template_out import JsonApiExportTemplateOut + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiExportTemplateInAttributes'] = JsonApiExportTemplateInAttributes + globals()['JsonApiExportTemplateOut'] = JsonApiExportTemplateOut + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiExportTemplateOutWithLinks(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',): { + 'EXPORTTEMPLATE': "exportTemplate", + }, + } + + 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': (JsonApiExportTemplateInAttributes,), # 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 + """JsonApiExportTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiExportTemplateInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # 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', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """JsonApiExportTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiExportTemplateInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # 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', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + JsonApiExportTemplateOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.py new file mode 100644 index 000000000..05afc5827 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.py @@ -0,0 +1,298 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_patch_attributes import JsonApiExportTemplatePatchAttributes + globals()['JsonApiExportTemplatePatchAttributes'] = JsonApiExportTemplatePatchAttributes + + +class JsonApiExportTemplatePatch(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'EXPORTTEMPLATE': "exportTemplate", + }, + } + + 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': (JsonApiExportTemplatePatchAttributes,), # 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 + """JsonApiExportTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiExportTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # 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', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + """JsonApiExportTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiExportTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # 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', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_export_template_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_attributes.py new file mode 100644 index 000000000..350a1f0f8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_attributes.py @@ -0,0 +1,283 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate + from gooddata_api_client.model.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate + globals()['JsonApiExportTemplateInAttributesDashboardSlidesTemplate'] = JsonApiExportTemplateInAttributesDashboardSlidesTemplate + globals()['JsonApiExportTemplateInAttributesWidgetSlidesTemplate'] = JsonApiExportTemplateInAttributesWidgetSlidesTemplate + + +class JsonApiExportTemplatePatchAttributes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'dashboard_slides_template': (JsonApiExportTemplateInAttributesDashboardSlidesTemplate,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'widget_slides_template': (JsonApiExportTemplateInAttributesWidgetSlidesTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 + 'name': 'name', # noqa: E501 + 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplatePatchAttributes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dashboard_slides_template (JsonApiExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 + name (str): User-facing name of the Slides template.. [optional] # noqa: E501 + widget_slides_template (JsonApiExportTemplateInAttributesWidgetSlidesTemplate): [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 + """JsonApiExportTemplatePatchAttributes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dashboard_slides_template (JsonApiExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 + name (str): User-facing name of the Slides template.. [optional] # noqa: E501 + widget_slides_template (JsonApiExportTemplateInAttributesWidgetSlidesTemplate): [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_export_template_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.py new file mode 100644 index 000000000..7301a717d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_patch import JsonApiExportTemplatePatch + globals()['JsonApiExportTemplatePatch'] = JsonApiExportTemplatePatch + + +class JsonApiExportTemplatePatchDocument(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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': (JsonApiExportTemplatePatch,), # 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 + """JsonApiExportTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiExportTemplatePatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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 + """JsonApiExportTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiExportTemplatePatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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_export_template_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.py new file mode 100644 index 000000000..bbad2489d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.py @@ -0,0 +1,296 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes + globals()['JsonApiExportTemplateInAttributes'] = JsonApiExportTemplateInAttributes + + +class JsonApiExportTemplatePostOptionalId(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'EXPORTTEMPLATE': "exportTemplate", + }, + } + + 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': (JsonApiExportTemplateInAttributes,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'type': 'type', # noqa: E501 + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiExportTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): API identifier of an object. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.attributes = attributes + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, *args, **kwargs): # noqa: E501 + """JsonApiExportTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiExportTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "exportTemplate", must be one of ["exportTemplate", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): API identifier of an object. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "exportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.attributes = attributes + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.py new file mode 100644 index 000000000..5b8f778ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId + globals()['JsonApiExportTemplatePostOptionalId'] = JsonApiExportTemplatePostOptionalId + + +class JsonApiExportTemplatePostOptionalIdDocument(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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': (JsonApiExportTemplatePostOptionalId,), # 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 + """JsonApiExportTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiExportTemplatePostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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 + """JsonApiExportTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiExportTemplatePostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py index 48bb809db..1b70c8f62 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py @@ -116,6 +116,7 @@ def openapi_types(): 'oauth_client_id': (str,), # noqa: E501 'oauth_client_secret': (str,), # noqa: E501 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 + 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 'oauth_issuer_id': (str,), # noqa: E501 'oauth_issuer_location': (str,), # noqa: E501 'oauth_subject_id_claim': (str,), # noqa: E501 @@ -135,6 +136,7 @@ def discriminator(): 'oauth_client_id': 'oauthClientId', # noqa: E501 'oauth_client_secret': 'oauthClientSecret', # noqa: E501 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 + 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 @@ -189,6 +191,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 oauth_client_id (str): [optional] # noqa: E501 oauth_client_secret (str): [optional] # noqa: E501 oauth_custom_auth_attributes ({str: (str,)}): 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] # noqa: E501 + oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 oauth_issuer_id (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] # noqa: E501 oauth_issuer_location (str): [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 @@ -285,6 +288,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 oauth_client_id (str): [optional] # noqa: E501 oauth_client_secret (str): [optional] # noqa: E501 oauth_custom_auth_attributes ({str: (str,)}): 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] # noqa: E501 + oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 oauth_issuer_id (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] # noqa: E501 oauth_issuer_location (str): [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py index a8d4d8153..44930cd85 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py @@ -119,6 +119,7 @@ def openapi_types(): 'name': (str, none_type,), # noqa: E501 'oauth_client_id': (str,), # noqa: E501 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 + 'oauth_custom_scopes': ([str], none_type,), # noqa: E501 'oauth_issuer_id': (str,), # noqa: E501 'oauth_issuer_location': (str,), # noqa: E501 'oauth_subject_id_claim': (str,), # noqa: E501 @@ -138,6 +139,7 @@ def discriminator(): 'name': 'name', # noqa: E501 'oauth_client_id': 'oauthClientId', # noqa: E501 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 + 'oauth_custom_scopes': 'oauthCustomScopes', # noqa: E501 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 @@ -192,6 +194,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 name (str, none_type): [optional] # noqa: E501 oauth_client_id (str): [optional] # noqa: E501 oauth_custom_auth_attributes ({str: (str,)}): 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] # noqa: E501 + oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 oauth_issuer_id (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] # noqa: E501 oauth_issuer_location (str): [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 @@ -288,6 +291,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 name (str, none_type): [optional] # noqa: E501 oauth_client_id (str): [optional] # noqa: E501 oauth_custom_auth_attributes ({str: (str,)}): 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] # noqa: E501 + oauth_custom_scopes ([str], none_type): List of additional OAuth scopes which may be required by other providers (e.g. Snowflake). [optional] # noqa: E501 oauth_issuer_id (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] # noqa: E501 oauth_issuer_location (str): [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 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 62aa42a79..becc7cc91 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 @@ -76,6 +76,7 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'DATE_FILTER_CONFIG': "DATE_FILTER_CONFIG", 'JIT_PROVISIONING': "JIT_PROVISIONING", 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", + 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", }, } 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 b0d31ff89..941f39c00 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py @@ -80,6 +80,7 @@ class ResolvedSetting(ModelNormal): 'DATE_FILTER_CONFIG': "DATE_FILTER_CONFIG", 'JIT_PROVISIONING': "JIT_PROVISIONING", 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", + 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/running_section.py b/gooddata-api-client/gooddata_api_client/model/running_section.py new file mode 100644 index 000000000..239c5489e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/running_section.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 RunningSection(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'left': (str, none_type,), # noqa: E501 + 'right': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'left': 'left', # noqa: E501 + 'right': 'right', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RunningSection - 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,) + left (str, none_type): Either {{logo}} variable or custom text with combination of other variables.. [optional] # noqa: E501 + right (str, none_type): Either {{logo}} variable or custom text with combination of other variables.. [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 + """RunningSection - 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,) + left (str, none_type): Either {{logo}} variable or custom text with combination of other variables.. [optional] # noqa: E501 + right (str, none_type): Either {{logo}} variable or custom text with combination of other variables.. [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/section_slide_template.py b/gooddata-api-client/gooddata_api_client/model/section_slide_template.py new file mode 100644 index 000000000..7c5111cf2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/section_slide_template.py @@ -0,0 +1,278 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.running_section import RunningSection + globals()['RunningSection'] = RunningSection + + +class SectionSlideTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'background_image': (bool,), # noqa: E501 + 'footer': (RunningSection,), # noqa: E501 + 'header': (RunningSection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_image': 'backgroundImage', # noqa: E501 + 'footer': 'footer', # noqa: E501 + 'header': 'header', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SectionSlideTemplate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 + footer (RunningSection): [optional] # noqa: E501 + header (RunningSection): [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 + """SectionSlideTemplate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + background_image (bool): Show background image on the slide.. [optional] if omitted the server will use the default value of True # noqa: E501 + footer (RunningSection): [optional] # noqa: E501 + header (RunningSection): [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/slides_export_request.py b/gooddata-api-client/gooddata_api_client/model/slides_export_request.py index 4d683b1a1..fb5d9037b 100644 --- a/gooddata-api-client/gooddata_api_client/model/slides_export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/slides_export_request.py @@ -67,6 +67,12 @@ class SlidesExportRequest(ModelNormal): } validations = { + ('template_id',): { + 'max_length': 255, + }, + ('visualization_ids',): { + 'max_items': 1, + }, ('widget_ids',): { 'max_items': 1, }, @@ -95,10 +101,12 @@ def openapi_types(): """ lazy_import() return { - 'dashboard_id': (str,), # noqa: E501 'file_name': (str,), # noqa: E501 'format': (str,), # noqa: E501 + 'dashboard_id': (str,), # noqa: E501 'metadata': (JsonNode,), # noqa: E501 + 'template_id': (str, none_type,), # noqa: E501 + 'visualization_ids': ([str],), # noqa: E501 'widget_ids': ([str],), # noqa: E501 } @@ -108,10 +116,12 @@ def discriminator(): attribute_map = { - 'dashboard_id': 'dashboardId', # noqa: E501 'file_name': 'fileName', # noqa: E501 'format': 'format', # noqa: E501 + 'dashboard_id': 'dashboardId', # noqa: E501 'metadata': 'metadata', # noqa: E501 + 'template_id': 'templateId', # noqa: E501 + 'visualization_ids': 'visualizationIds', # noqa: E501 'widget_ids': 'widgetIds', # noqa: E501 } @@ -122,11 +132,10 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, dashboard_id, file_name, format, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, file_name, format, *args, **kwargs): # noqa: E501 """SlidesExportRequest - a model defined in OpenAPI Args: - dashboard_id (str): Dashboard identifier file_name (str): File name to be used for retrieving the pdf document. format (str): Requested resulting file type. @@ -161,7 +170,10 @@ def _from_openapi_data(cls, dashboard_id, file_name, format, *args, **kwargs): Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 metadata (JsonNode): [optional] # noqa: E501 + template_id (str, none_type): Export template identifier.. [optional] # noqa: E501 + visualization_ids ([str]): List of visualization ids to be exported. Note that only one visualization is currently supported.. [optional] # noqa: E501 widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 """ @@ -194,7 +206,6 @@ def _from_openapi_data(cls, dashboard_id, file_name, format, *args, **kwargs): self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.dashboard_id = dashboard_id self.file_name = file_name self.format = format for var_name, var_value in kwargs.items(): @@ -217,11 +228,10 @@ def _from_openapi_data(cls, dashboard_id, file_name, format, *args, **kwargs): ]) @convert_js_args_to_python_args - def __init__(self, dashboard_id, file_name, format, *args, **kwargs): # noqa: E501 + def __init__(self, file_name, format, *args, **kwargs): # noqa: E501 """SlidesExportRequest - a model defined in OpenAPI Args: - dashboard_id (str): Dashboard identifier file_name (str): File name to be used for retrieving the pdf document. format (str): Requested resulting file type. @@ -256,7 +266,10 @@ def __init__(self, dashboard_id, file_name, format, *args, **kwargs): # noqa: E Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 metadata (JsonNode): [optional] # noqa: E501 + template_id (str, none_type): Export template identifier.. [optional] # noqa: E501 + visualization_ids ([str]): List of visualization ids to be exported. Note that only one visualization is currently supported.. [optional] # noqa: E501 widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 """ @@ -287,7 +300,6 @@ def __init__(self, dashboard_id, file_name, format, *args, **kwargs): # noqa: E self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.dashboard_id = dashboard_id self.file_name = file_name self.format = format for var_name, var_value in kwargs.items(): diff --git a/gooddata-api-client/gooddata_api_client/model/visible_filter.py b/gooddata-api-client/gooddata_api_client/model/visible_filter.py new file mode 100644 index 000000000..433340a50 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visible_filter.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 VisibleFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'local_identifier': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'local_identifier': 'localIdentifier', # 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 + """VisibleFilter - 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,) + local_identifier (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 + """VisibleFilter - 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,) + local_identifier (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/widget_slides_template.py b/gooddata-api-client/gooddata_api_client/model/widget_slides_template.py new file mode 100644 index 000000000..b958de7aa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/widget_slides_template.py @@ -0,0 +1,287 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.content_slide_template import ContentSlideTemplate + globals()['ContentSlideTemplate'] = ContentSlideTemplate + + +class WidgetSlidesTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('applied_on',): { + 'PDF': "PDF", + 'PPTX': "PPTX", + }, + } + + validations = { + ('applied_on',): { + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'applied_on': ([str],), # noqa: E501 + 'content_slide': (ContentSlideTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'applied_on': 'appliedOn', # noqa: E501 + 'content_slide': 'contentSlide', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 + """WidgetSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.applied_on = applied_on + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, applied_on, *args, **kwargs): # noqa: E501 + """WidgetSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.applied_on = applied_on + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index 1faf9824a..ac36293ad 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -15,6 +15,7 @@ from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter from gooddata_api_client.model.active_object_identification import ActiveObjectIdentification from gooddata_api_client.model.ad_hoc_automation import AdHocAutomation +from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens from gooddata_api_client.model.afm_execution import AfmExecution from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse from gooddata_api_client.model.afm_identifier import AfmIdentifier @@ -61,6 +62,7 @@ from gooddata_api_client.model.automation_alert import AutomationAlert from gooddata_api_client.model.automation_alert_condition import AutomationAlertCondition from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.model.automation_metadata import AutomationMetadata 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.automation_schedule import AutomationSchedule @@ -86,6 +88,8 @@ 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.comparison_wrapper import ComparisonWrapper +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.created_visualization import CreatedVisualization from gooddata_api_client.model.created_visualization_filters_inner import CreatedVisualizationFiltersInner from gooddata_api_client.model.created_visualizations import CreatedVisualizations @@ -94,6 +98,7 @@ from gooddata_api_client.model.custom_override import CustomOverride from gooddata_api_client.model.dashboard_permissions import DashboardPermissions from gooddata_api_client.model.dashboard_permissions_assignment import DashboardPermissionsAssignment +from gooddata_api_client.model.dashboard_slides_template import DashboardSlidesTemplate from gooddata_api_client.model.data_column_locator import DataColumnLocator from gooddata_api_client.model.data_column_locators import DataColumnLocators from gooddata_api_client.model.data_source_parameter import DataSourceParameter @@ -138,6 +143,8 @@ from gooddata_api_client.model.declarative_export_definition import DeclarativeExportDefinition from gooddata_api_client.model.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier from gooddata_api_client.model.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload +from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates from gooddata_api_client.model.declarative_fact import DeclarativeFact from gooddata_api_client.model.declarative_filter_context import DeclarativeFilterContext from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView @@ -229,6 +236,7 @@ from gooddata_api_client.model.frequency_bucket import FrequencyBucket from gooddata_api_client.model.frequency_properties import FrequencyProperties from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.model.get_slides_export202_response_inner import GetSlidesExport202ResponseInner from gooddata_api_client.model.grain_identifier import GrainIdentifier from gooddata_api_client.model.granted_permission import GrantedPermission from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting @@ -244,6 +252,7 @@ from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition from gooddata_api_client.model.inline_measure_definition_inline import InlineMeasureDefinitionInline +from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate from gooddata_api_client.model.json_api_analytical_dashboard_in import JsonApiAnalyticalDashboardIn from gooddata_api_client.model.json_api_analytical_dashboard_in_attributes import JsonApiAnalyticalDashboardInAttributes from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument @@ -314,6 +323,7 @@ from gooddata_api_client.model.json_api_automation_in_attributes import JsonApiAutomationInAttributes from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert from gooddata_api_client.model.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner +from gooddata_api_client.model.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner @@ -448,6 +458,20 @@ from gooddata_api_client.model.json_api_export_definition_post_optional_id import JsonApiExportDefinitionPostOptionalId from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument from gooddata_api_client.model.json_api_export_definition_to_many_linkage import JsonApiExportDefinitionToManyLinkage +from gooddata_api_client.model.json_api_export_template_in import JsonApiExportTemplateIn +from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from gooddata_api_client.model.json_api_export_template_in_attributes_dashboard_slides_template import JsonApiExportTemplateInAttributesDashboardSlidesTemplate +from gooddata_api_client.model.json_api_export_template_in_attributes_widget_slides_template import JsonApiExportTemplateInAttributesWidgetSlidesTemplate +from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.model.json_api_export_template_out import JsonApiExportTemplateOut +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.model.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks +from gooddata_api_client.model.json_api_export_template_patch import JsonApiExportTemplatePatch +from gooddata_api_client.model.json_api_export_template_patch_attributes import JsonApiExportTemplatePatchAttributes +from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.model.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId +from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_fact_linkage import JsonApiFactLinkage from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut from gooddata_api_client.model.json_api_fact_out_attributes import JsonApiFactOutAttributes @@ -793,6 +817,7 @@ 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.running_section import RunningSection 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 @@ -801,6 +826,7 @@ from gooddata_api_client.model.search_request import SearchRequest from gooddata_api_client.model.search_result import SearchResult from gooddata_api_client.model.search_result_object import SearchResultObject +from gooddata_api_client.model.section_slide_template import SectionSlideTemplate from gooddata_api_client.model.settings import Settings from gooddata_api_client.model.simple_measure_definition import SimpleMeasureDefinition from gooddata_api_client.model.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure @@ -854,6 +880,7 @@ from gooddata_api_client.model.user_permission import UserPermission from gooddata_api_client.model.validate_by_item import ValidateByItem 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.webhook import Webhook from gooddata_api_client.model.webhook_all_of import WebhookAllOf @@ -861,6 +888,7 @@ 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.widget_slides_template import WidgetSlidesTemplate from gooddata_api_client.model.workspace_data_source import WorkspaceDataSource from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index ff0b62a4a..156f80555 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -115,6 +115,22 @@ ], "type": "object" }, + "AfmCancelTokens": { + "description": "Any information related to cancellation.", + "properties": { + "tokenIds": { + "description": "Token ids to be used in the cancellation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "tokenIds" + ], + "type": "object" + }, "AfmExecution": { "properties": { "execution": { @@ -1763,6 +1779,11 @@ "maximum": 100, "minimum": 0, "type": "number" + }, + "timestamp": { + "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", + "format": "date-time", + "type": "string" } }, "type": "object" @@ -3451,6 +3472,56 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel": { + "post": { + "description": "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is canceled.", + "operationId": "cancelExecutions", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmCancelTokens" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmCancelTokens" + } + } + }, + "description": "Status of the cancelling operation." + } + }, + "summary": "Applies all the given cancel tokens.", + "tags": [ + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants": { "post": { "description": "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", @@ -3579,11 +3650,13 @@ } }, { + "deprecated": true, "example": "2020-06-03T10:15:30+01:00", "in": "header", "name": "timestamp", "required": false, "schema": { + "description": "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", "format": "timestamp", "type": "string" } @@ -3608,7 +3681,16 @@ } } }, - "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request." + "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", + "headers": { + "X-GDC-CANCEL-TOKEN": { + "description": "A token that can be used to cancel this execution", + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, "summary": "Executes analytical request and returns link to the result", @@ -3698,6 +3780,14 @@ "type": "array" }, "style": "form" + }, + { + "in": "header", + "name": "X-GDC-CANCEL-TOKEN", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index f92208e08..cdbc8c4c5 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -188,7 +188,7 @@ "uniqueItems": true }, "metadata": { - "$ref": "#/components/schemas/JsonNode" + "$ref": "#/components/schemas/AutomationMetadata" }, "notificationChannel": { "$ref": "#/components/schemas/DeclarativeNotificationChannelIdentifier" @@ -233,6 +233,22 @@ }, "type": "object" }, + "AfmCancelTokens": { + "description": "Any information related to cancellation.", + "properties": { + "tokenIds": { + "description": "Token ids to be used in the cancellation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "tokenIds" + ], + "type": "object" + }, "AfmExecution": { "properties": { "execution": { @@ -752,7 +768,8 @@ "DailyAlertActionCount", "UnlimitedDailyAlertActions", "ScheduledActionMinimumRecurrenceMinutes", - "FederatedIdentityManagement" + "FederatedIdentityManagement", + "AuditLogging" ], "type": "string" }, @@ -1145,6 +1162,23 @@ ], "type": "object" }, + "AutomationMetadata": { + "description": "Additional information for the automation.", + "maxLength": 15000, + "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, + "type": "object" + }, "AutomationNotification": { "allOf": [ { @@ -1770,6 +1804,47 @@ ], "type": "object" }, + "ContentSlideTemplate": { + "description": "Settings for content slide.", + "nullable": true, + "properties": { + "descriptionField": { + "example": "{{dashboardFilters}}", + "nullable": true, + "type": "string" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, + "CoverSlideTemplate": { + "description": "Settings for cover slide.", + "nullable": true, + "properties": { + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" + }, + "descriptionField": { + "example": "Exported at: {{exportedAt}}", + "nullable": true, + "type": "string" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, "CreatedVisualization": { "description": "List of created visualization objects", "properties": { @@ -1980,6 +2055,44 @@ ], "type": "object" }, + "DashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, "DataColumnLocator": { "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", "example": { @@ -2748,7 +2861,7 @@ "type": "string" }, "metadata": { - "$ref": "#/components/schemas/JsonNode" + "$ref": "#/components/schemas/AutomationMetadata" }, "modifiedAt": { "description": "Time of the last entity modification.", @@ -3472,6 +3585,49 @@ ], "type": "object" }, + "DeclarativeExportTemplate": { + "description": "A declarative form of a particular export template.", + "properties": { + "dashboardSlidesTemplate": { + "$ref": "#/components/schemas/DashboardSlidesTemplate" + }, + "id": { + "description": "Identifier of an export template", + "example": "default-export-template", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "name": { + "description": "Name of an export template.", + "example": "My default export template", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "$ref": "#/components/schemas/WidgetSlidesTemplate" + } + }, + "required": [ + "id", + "name" + ], + "type": "object" + }, + "DeclarativeExportTemplates": { + "description": "Export templates.", + "properties": { + "exportTemplates": { + "items": { + "$ref": "#/components/schemas/DeclarativeExportTemplate" + }, + "type": "array" + } + }, + "required": [ + "exportTemplates" + ], + "type": "object" + }, "DeclarativeFact": { "description": "A dataset fact.", "properties": { @@ -4020,6 +4176,12 @@ }, "type": "array" }, + "exportTemplates": { + "items": { + "$ref": "#/components/schemas/DeclarativeExportTemplate" + }, + "type": "array" + }, "identityProviders": { "items": { "$ref": "#/components/schemas/DeclarativeIdentityProvider" @@ -4147,6 +4309,15 @@ "maxLength": 10000, "type": "object" }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -4399,7 +4570,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "example": "TIMEZONE", "type": "string" @@ -5718,7 +5890,8 @@ "DailyAlertActionCount", "UnlimitedDailyAlertActions", "ScheduledActionMinimumRecurrenceMinutes", - "FederatedIdentityManagement" + "FederatedIdentityManagement", + "AuditLogging" ], "type": "string" }, @@ -5958,6 +6131,11 @@ "maximum": 100, "minimum": 0, "type": "number" + }, + "timestamp": { + "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", + "format": "date-time", + "type": "string" } }, "type": "object" @@ -6684,6 +6862,34 @@ ], "type": "object" }, + "IntroSlideTemplate": { + "description": "Settings for intro slide.", + "nullable": true, + "properties": { + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" + }, + "descriptionField": { + "example": "About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + "nullable": true, + "type": "string" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + }, + "titleField": { + "example": "Introduction", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, "JsonApiAnalyticalDashboardIn": { "description": "JSON:API representation of analyticalDashboard entity.", "properties": { @@ -8107,6 +8313,17 @@ "description": "Additional information for the automation.", "maxLength": 15000, "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, "type": "object" }, "schedule": { @@ -8354,6 +8571,17 @@ "description": "Additional information for the automation.", "maxLength": 15000, "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, "type": "object" }, "modifiedAt": { @@ -8705,6 +8933,17 @@ "description": "Additional information for the automation.", "maxLength": 15000, "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, "type": "object" }, "schedule": { @@ -10398,7 +10637,8 @@ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", - "CLIENT_SECRET" + "CLIENT_SECRET", + "ACCESS_TOKEN" ], "nullable": true, "type": "string" @@ -11598,105 +11838,592 @@ ], "type": "object" }, - "JsonApiExportDefinitionOutWithLinks": { + "JsonApiExportDefinitionOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiExportDefinitionOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiExportDefinitionPatch": { + "description": "JSON:API representation of patching exportDefinition entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "requestPayload": { + "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", + "oneOf": [ + { + "$ref": "#/components/schemas/VisualExportRequest" + }, + { + "$ref": "#/components/schemas/TabularExportRequest" + } + ], + "type": "object" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "analyticalDashboard": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "visualizationObject": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "exportDefinition" + ], + "example": "exportDefinition", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiExportDefinitionPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportDefinitionPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportDefinitionPostOptionalId": { + "description": "JSON:API representation of exportDefinition entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "requestPayload": { + "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", + "oneOf": [ + { + "$ref": "#/components/schemas/VisualExportRequest" + }, + { + "$ref": "#/components/schemas/TabularExportRequest" + } + ], + "type": "object" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "analyticalDashboard": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "visualizationObject": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "exportDefinition" + ], + "example": "exportDefinition", + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "JsonApiExportDefinitionPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportDefinitionToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiExportDefinitionLinkage" + }, + "type": "array" + }, + "JsonApiExportTemplateIn": { + "description": "JSON:API representation of exportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "exportTemplate" + ], + "example": "exportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiExportTemplateInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportTemplateIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportTemplateOut": { + "description": "JSON:API representation of exportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "exportTemplate" + ], + "example": "exportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiExportTemplateOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportTemplateOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportTemplateOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportTemplateOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiExportDefinitionOut" + "$ref": "#/components/schemas/JsonApiExportTemplateOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiExportDefinitionPatch": { - "description": "JSON:API representation of patching exportDefinition entity.", + "JsonApiExportTemplatePatch": { + "description": "JSON:API representation of patching exportTemplate entity.", "properties": { "attributes": { "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "requestPayload": { - "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", - "oneOf": [ - { - "$ref": "#/components/schemas/VisualExportRequest" + "dashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" }, - { - "$ref": "#/components/schemas/TabularExportRequest" + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" } + }, + "required": [ + "appliedOn" ], "type": "object" }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { + "name": { + "description": "User-facing name of the Slides template.", "maxLength": 255, "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" }, - "visualizationObject": { + "widgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ - "data" + "appliedOn" ], "type": "object" } }, "type": "object" }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, "type": { "description": "Object type", "enum": [ - "exportDefinition" + "exportTemplate" ], - "example": "exportDefinition", + "example": "exportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiExportDefinitionPatchDocument": { + "JsonApiExportTemplatePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatch" + "$ref": "#/components/schemas/JsonApiExportTemplatePatch" } }, "required": [ @@ -11704,94 +12431,114 @@ ], "type": "object" }, - "JsonApiExportDefinitionPostOptionalId": { - "description": "JSON:API representation of exportDefinition entity.", + "JsonApiExportTemplatePostOptionalId": { + "description": "JSON:API representation of exportTemplate entity.", "properties": { "attributes": { "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "requestPayload": { - "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", - "oneOf": [ - { - "$ref": "#/components/schemas/VisualExportRequest" + "dashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" }, - { - "$ref": "#/components/schemas/TabularExportRequest" + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" } + }, + "required": [ + "appliedOn" ], "type": "object" }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { + "name": { + "description": "User-facing name of the Slides template.", "maxLength": 255, "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" }, - "visualizationObject": { + "widgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ - "data" + "appliedOn" ], "type": "object" } }, + "required": [ + "name" + ], "type": "object" }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, "type": { "description": "Object type", "enum": [ - "exportDefinition" + "exportTemplate" ], - "example": "exportDefinition", + "example": "exportTemplate", "type": "string" } }, "required": [ + "attributes", "type" ], "type": "object" }, - "JsonApiExportDefinitionPostOptionalIdDocument": { + "JsonApiExportTemplatePostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalId" + "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalId" } }, "required": [ @@ -11799,13 +12546,6 @@ ], "type": "object" }, - "JsonApiExportDefinitionToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiExportDefinitionLinkage" - }, - "type": "array" - }, "JsonApiFactLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { @@ -14844,10 +15584,135 @@ "maxLength": 255, "type": "string" }, - "oauthClientSecret": { - "maxLength": 255, - "type": "string" - }, + "oauthClientSecret": { + "maxLength": 255, + "type": "string" + }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "oauthIssuerId": { + "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example": "myOidcProvider", + "maxLength": 255, + "type": "string" + }, + "oauthIssuerLocation": { + "maxLength": 255, + "type": "string" + }, + "oauthSubjectIdClaim": { + "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example": "oid", + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "organization" + ], + "example": "organization", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiOrganizationInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiOrganizationIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiOrganizationOut": { + "description": "JSON:API representation of organization entity.", + "properties": { + "attributes": { + "properties": { + "allowedOrigins": { + "items": { + "type": "string" + }, + "type": "array" + }, + "cacheSettings": { + "properties": { + "cacheStrategy": { + "enum": [ + "DURABLE", + "EPHEMERAL" + ], + "maxLength": 255, + "type": "string" + }, + "extraCacheBudget": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "earlyAccess": { + "deprecated": true, + "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "earlyAccessValues": { + "description": "The early access feature identifiers. They are used to enable experimental features.", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "hostname": { + "maxLength": 255, + "type": "string" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "oauthClientId": { + "maxLength": 255, + "type": "string" + }, "oauthCustomAuthAttributes": { "additionalProperties": { "type": "string" @@ -14856,94 +15721,8 @@ "maxLength": 10000, "type": "object" }, - "oauthIssuerId": { - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider", - "maxLength": 255, - "type": "string" - }, - "oauthIssuerLocation": { - "maxLength": 255, - "type": "string" - }, - "oauthSubjectIdClaim": { - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid", - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "organization" - ], - "example": "organization", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiOrganizationInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiOrganizationIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiOrganizationOut": { - "description": "JSON:API representation of organization entity.", - "properties": { - "attributes": { - "properties": { - "allowedOrigins": { - "items": { - "type": "string" - }, - "type": "array" - }, - "cacheSettings": { - "properties": { - "cacheStrategy": { - "enum": [ - "DURABLE", - "EPHEMERAL" - ], - "maxLength": 255, - "type": "string" - }, - "extraCacheBudget": { - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", "items": { "maxLength": 255, "type": "string" @@ -14951,27 +15730,6 @@ "nullable": true, "type": "array" }, - "hostname": { - "maxLength": 255, - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "oauthClientId": { - "maxLength": 255, - "type": "string" - }, - "oauthCustomAuthAttributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", - "maxLength": 10000, - "type": "object" - }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -15139,6 +15897,15 @@ "maxLength": 10000, "type": "object" }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -15220,7 +15987,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -15289,7 +16057,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -15398,7 +16167,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -16873,7 +17643,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -16942,7 +17713,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -18688,7 +19460,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -18757,7 +19530,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -18892,7 +19666,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -18961,7 +19736,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -20484,7 +21260,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "example": "TIMEZONE", "type": "string" @@ -20693,6 +21470,23 @@ ], "type": "object" }, + "RunningSection": { + "description": "Footer section of the slide", + "nullable": true, + "properties": { + "left": { + "description": "Either {{logo}} variable or custom text with combination of other variables.", + "nullable": true, + "type": "string" + }, + "right": { + "description": "Either {{logo}} variable or custom text with combination of other variables.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, "ScanRequest": { "description": "A request containing all information critical to model scanning.", "properties": { @@ -21000,6 +21794,24 @@ ], "type": "object" }, + "SectionSlideTemplate": { + "description": "Settings for section slide.", + "nullable": true, + "properties": { + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, "ServerSentEventChatResult": { "type": "object" }, @@ -21146,17 +21958,32 @@ "metadata": { "$ref": "#/components/schemas/JsonNode" }, + "templateId": { + "description": "Export template identifier.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "visualizationIds": { + "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { "type": "string" }, "maxItems": 1, - "type": "array" + "type": "array", + "uniqueItems": true } }, "required": [ - "dashboardId", "fileName", "format" ], @@ -22320,6 +23147,17 @@ ], "type": "object" }, + "VisibleFilter": { + "properties": { + "localIdentifier": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, "VisualExportRequest": { "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", "properties": { @@ -22521,6 +23359,35 @@ ], "type": "object" }, + "WidgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, "WorkspaceDataSource": { "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", "properties": { @@ -24880,6 +25747,56 @@ } } }, + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel": { + "post": { + "description": "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is canceled.", + "operationId": "cancelExecutions", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmCancelTokens" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmCancelTokens" + } + } + }, + "description": "Status of the cancelling operation." + } + }, + "summary": "Applies all the given cancel tokens.", + "tags": [ + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants": { "post": { "description": "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", @@ -25008,11 +25925,13 @@ } }, { + "deprecated": true, "example": "2020-06-03T10:15:30+01:00", "in": "header", "name": "timestamp", "required": false, "schema": { + "description": "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", "format": "timestamp", "type": "string" } @@ -25037,7 +25956,16 @@ } } }, - "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request." + "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", + "headers": { + "X-GDC-CANCEL-TOKEN": { + "description": "A token that can be used to cancel this execution", + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, "summary": "Executes analytical request and returns link to the result", @@ -25127,6 +26055,14 @@ "type": "array" }, "style": "form" + }, + { + "in": "header", + "name": "X-GDC-CANCEL-TOKEN", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -26036,7 +26972,7 @@ }, "summary": "(EXPERIMENTAL) Create slides export request", "tags": [ - "Slideshow export", + "Slides export", "actions" ], "x-gdc-security-info": { @@ -26091,14 +27027,80 @@ "content": { "application/pdf": { "schema": { - "format": "binary", - "type": "string" + "items": { + "properties": { + "char": { + "type": "string" + }, + "direct": { + "type": "boolean" + }, + "double": { + "format": "double", + "type": "number" + }, + "float": { + "format": "float", + "type": "number" + }, + "int": { + "format": "int32", + "type": "integer" + }, + "long": { + "format": "int64", + "type": "integer" + }, + "readOnly": { + "type": "boolean" + }, + "short": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" } }, "application/vnd.openxmlformats-officedocument.presentationml.presentation": { "schema": { - "format": "binary", - "type": "string" + "items": { + "properties": { + "char": { + "type": "string" + }, + "direct": { + "type": "boolean" + }, + "double": { + "format": "double", + "type": "number" + }, + "float": { + "format": "float", + "type": "number" + }, + "int": { + "format": "int32", + "type": "integer" + }, + "long": { + "format": "int64", + "type": "integer" + }, + "readOnly": { + "type": "boolean" + }, + "short": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" } } }, @@ -26107,7 +27109,7 @@ }, "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ - "Slideshow export", + "Slides export", "actions" ], "x-gdc-security-info": { @@ -26150,7 +27152,7 @@ }, "summary": "(EXPERIMENTAL) Retrieve metadata context", "tags": [ - "Slideshow export", + "Slides export", "actions" ], "x-gdc-security-info": { @@ -28518,6 +29520,251 @@ ] } }, + "/api/v1/entities/exportTemplates": { + "get": { + "operationId": "getAllEntities@ExportTemplates", + "parameters": [ + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "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/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "GET all Export Template entities", + "tags": [ + "entities", + "organization-model-controller" + ] + }, + "post": { + "operationId": "createEntity@ExportTemplates", + "requestBody": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Export Template entities", + "tags": [ + "entities", + "organization-model-controller" + ] + } + }, + "/api/v1/entities/exportTemplates/{id}": { + "delete": { + "operationId": "deleteEntity@ExportTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Export Template entity", + "tags": [ + "entities", + "organization-model-controller" + ] + }, + "get": { + "operationId": "getEntity@ExportTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "GET Export Template entity", + "tags": [ + "entities", + "organization-model-controller" + ] + }, + "patch": { + "operationId": "patchEntity@ExportTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch Export Template entity", + "tags": [ + "entities", + "organization-model-controller" + ] + }, + "put": { + "operationId": "updateEntity@ExportTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "PUT Export Template entity", + "tags": [ + "entities", + "organization-model-controller" + ] + } + }, "/api/v1/entities/identityProviders": { "get": { "operationId": "getAllEntities@IdentityProviders", @@ -40424,6 +41671,65 @@ } } }, + "/api/v1/layout/exportTemplates": { + "get": { + "description": "Gets complete layout of export templates.", + "operationId": "getExportTemplatesLayout", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeclarativeExportTemplates" + } + } + }, + "description": "Retrieved layout of all export templates." + } + }, + "summary": "Get all export templates layout", + "tags": [ + "layout", + "Notification Channels" + ], + "x-gdc-security-info": { + "description": "Permission required to get export templates layout.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "description": "Sets export templates in organization.", + "operationId": "setExportTemplates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeclarativeExportTemplates" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "All export templates set." + } + }, + "summary": "Set all export templates", + "tags": [ + "layout", + "Notification Channels" + ], + "x-gdc-security-info": { + "description": "Permission required to set export templates layout.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/layout/identityProviders": { "get": { "description": "Gets complete layout of identity providers.", diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index a58322692..7ca4dc80e 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -29,7 +29,7 @@ "uniqueItems": true }, "metadata": { - "$ref": "#/components/schemas/JsonNode" + "$ref": "#/components/schemas/AutomationMetadata" }, "notificationChannel": { "$ref": "#/components/schemas/DeclarativeNotificationChannelIdentifier" @@ -174,6 +174,23 @@ ], "type": "object" }, + "AutomationMetadata": { + "description": "Additional information for the automation.", + "maxLength": 15000, + "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, + "type": "object" + }, "AutomationNotification": { "allOf": [ { @@ -841,6 +858,17 @@ ], "type": "object" }, + "VisibleFilter": { + "properties": { + "localIdentifier": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, "VisualExportRequest": { "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", "properties": { diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index cc34d719d..3e63c4760 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -498,6 +498,11 @@ "maximum": 100, "minimum": 0, "type": "number" + }, + "timestamp": { + "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", + "format": "date-time", + "type": "string" } }, "type": "object" @@ -1249,17 +1254,32 @@ "metadata": { "$ref": "#/components/schemas/JsonNode" }, + "templateId": { + "description": "Export template identifier.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "visualizationIds": { + "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { "type": "string" }, "maxItems": 1, - "type": "array" + "type": "array", + "uniqueItems": true } }, "required": [ - "dashboardId", "fileName", "format" ], @@ -1568,7 +1588,7 @@ }, "summary": "(EXPERIMENTAL) Create slides export request", "tags": [ - "Slideshow export", + "Slides export", "actions" ], "x-gdc-security-info": { @@ -1623,14 +1643,80 @@ "content": { "application/pdf": { "schema": { - "format": "binary", - "type": "string" + "items": { + "properties": { + "char": { + "type": "string" + }, + "direct": { + "type": "boolean" + }, + "double": { + "format": "double", + "type": "number" + }, + "float": { + "format": "float", + "type": "number" + }, + "int": { + "format": "int32", + "type": "integer" + }, + "long": { + "format": "int64", + "type": "integer" + }, + "readOnly": { + "type": "boolean" + }, + "short": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" } }, "application/vnd.openxmlformats-officedocument.presentationml.presentation": { "schema": { - "format": "binary", - "type": "string" + "items": { + "properties": { + "char": { + "type": "string" + }, + "direct": { + "type": "boolean" + }, + "double": { + "format": "double", + "type": "number" + }, + "float": { + "format": "float", + "type": "number" + }, + "int": { + "format": "int32", + "type": "integer" + }, + "long": { + "format": "int64", + "type": "integer" + }, + "readOnly": { + "type": "boolean" + }, + "short": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" } } }, @@ -1639,7 +1725,7 @@ }, "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ - "Slideshow export", + "Slides export", "actions" ], "x-gdc-security-info": { @@ -1682,7 +1768,7 @@ }, "summary": "(EXPERIMENTAL) Retrieve metadata context", "tags": [ - "Slideshow export", + "Slides export", "actions" ], "x-gdc-security-info": { diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index 6b7ebaceb..d8c7f9305 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -379,7 +379,8 @@ "DailyAlertActionCount", "UnlimitedDailyAlertActions", "ScheduledActionMinimumRecurrenceMinutes", - "FederatedIdentityManagement" + "FederatedIdentityManagement", + "AuditLogging" ], "type": "string" }, @@ -592,6 +593,23 @@ ], "type": "object" }, + "AutomationMetadata": { + "description": "Additional information for the automation.", + "maxLength": 15000, + "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, + "type": "object" + }, "AutomationSchedule": { "properties": { "cron": { @@ -803,6 +821,47 @@ ], "type": "object" }, + "ContentSlideTemplate": { + "description": "Settings for content slide.", + "nullable": true, + "properties": { + "descriptionField": { + "example": "{{dashboardFilters}}", + "nullable": true, + "type": "string" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, + "CoverSlideTemplate": { + "description": "Settings for cover slide.", + "nullable": true, + "properties": { + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" + }, + "descriptionField": { + "example": "Exported at: {{exportedAt}}", + "nullable": true, + "type": "string" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, "CustomLabel": { "description": "Custom label object override.", "properties": { @@ -905,6 +964,44 @@ ], "type": "object" }, + "DashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, "DataSourcePermissionAssignment": { "description": "Data source permission assignments", "properties": { @@ -1516,7 +1613,7 @@ "type": "string" }, "metadata": { - "$ref": "#/components/schemas/JsonNode" + "$ref": "#/components/schemas/AutomationMetadata" }, "modifiedAt": { "description": "Time of the last entity modification.", @@ -2241,6 +2338,49 @@ ], "type": "object" }, + "DeclarativeExportTemplate": { + "description": "A declarative form of a particular export template.", + "properties": { + "dashboardSlidesTemplate": { + "$ref": "#/components/schemas/DashboardSlidesTemplate" + }, + "id": { + "description": "Identifier of an export template", + "example": "default-export-template", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "name": { + "description": "Name of an export template.", + "example": "My default export template", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "$ref": "#/components/schemas/WidgetSlidesTemplate" + } + }, + "required": [ + "id", + "name" + ], + "type": "object" + }, + "DeclarativeExportTemplates": { + "description": "Export templates.", + "properties": { + "exportTemplates": { + "items": { + "$ref": "#/components/schemas/DeclarativeExportTemplate" + }, + "type": "array" + } + }, + "required": [ + "exportTemplates" + ], + "type": "object" + }, "DeclarativeFact": { "description": "A dataset fact.", "properties": { @@ -2789,6 +2929,12 @@ }, "type": "array" }, + "exportTemplates": { + "items": { + "$ref": "#/components/schemas/DeclarativeExportTemplate" + }, + "type": "array" + }, "identityProviders": { "items": { "$ref": "#/components/schemas/DeclarativeIdentityProvider" @@ -2916,6 +3062,15 @@ "maxLength": 10000, "type": "object" }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -3168,7 +3323,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "example": "TIMEZONE", "type": "string" @@ -4166,7 +4322,8 @@ "DailyAlertActionCount", "UnlimitedDailyAlertActions", "ScheduledActionMinimumRecurrenceMinutes", - "FederatedIdentityManagement" + "FederatedIdentityManagement", + "AuditLogging" ], "type": "string" }, @@ -4662,6 +4819,34 @@ ], "type": "object" }, + "IntroSlideTemplate": { + "description": "Settings for intro slide.", + "nullable": true, + "properties": { + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" + }, + "descriptionField": { + "example": "About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + "nullable": true, + "type": "string" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + }, + "titleField": { + "example": "Introduction", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, "JsonApiAnalyticalDashboardIn": { "description": "JSON:API representation of analyticalDashboard entity.", "properties": { @@ -6085,6 +6270,17 @@ "description": "Additional information for the automation.", "maxLength": 15000, "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, "type": "object" }, "schedule": { @@ -6332,6 +6528,17 @@ "description": "Additional information for the automation.", "maxLength": 15000, "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, "type": "object" }, "modifiedAt": { @@ -6683,6 +6890,17 @@ "description": "Additional information for the automation.", "maxLength": 15000, "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, "type": "object" }, "schedule": { @@ -8376,7 +8594,8 @@ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", - "CLIENT_SECRET" + "CLIENT_SECRET", + "ACCESS_TOKEN" ], "nullable": true, "type": "string" @@ -9784,6 +10003,506 @@ }, "type": "array" }, + "JsonApiExportTemplateIn": { + "description": "JSON:API representation of exportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "exportTemplate" + ], + "example": "exportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiExportTemplateInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportTemplateIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportTemplateOut": { + "description": "JSON:API representation of exportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "exportTemplate" + ], + "example": "exportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiExportTemplateOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportTemplateOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportTemplateOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportTemplateOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiExportTemplateOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiExportTemplatePatch": { + "description": "JSON:API representation of patching exportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "exportTemplate" + ], + "example": "exportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiExportTemplatePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportTemplatePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiExportTemplatePostOptionalId": { + "description": "JSON:API representation of exportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "exportTemplate" + ], + "example": "exportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiExportTemplatePostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "JsonApiFactLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { @@ -12834,6 +13553,15 @@ "maxLength": 10000, "type": "object" }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -12950,6 +13678,15 @@ "maxLength": 10000, "type": "object" }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -13117,6 +13854,15 @@ "maxLength": 10000, "type": "object" }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -13198,7 +13944,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -13267,7 +14014,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -13376,7 +14124,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -14851,7 +15600,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -14920,7 +15670,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -16666,7 +17417,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -16735,7 +17487,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -16870,7 +17623,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -16939,7 +17693,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "type": "string" } @@ -18021,7 +18776,8 @@ "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE" + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT" ], "example": "TIMEZONE", "type": "string" @@ -18107,6 +18863,41 @@ ], "type": "object" }, + "RunningSection": { + "description": "Footer section of the slide", + "nullable": true, + "properties": { + "left": { + "description": "Either {{logo}} variable or custom text with combination of other variables.", + "nullable": true, + "type": "string" + }, + "right": { + "description": "Either {{logo}} variable or custom text with combination of other variables.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "SectionSlideTemplate": { + "description": "Settings for section slide.", + "nullable": true, + "properties": { + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, "Settings": { "description": "Additional settings.", "properties": { @@ -18777,6 +19568,17 @@ ], "type": "object" }, + "VisibleFilter": { + "properties": { + "localIdentifier": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, "VisualExportRequest": { "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", "properties": { @@ -18845,6 +19647,35 @@ ], "type": "object" }, + "WidgetSlidesTemplate": { + "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, "WorkspaceDataSource": { "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", "properties": { @@ -22325,6 +23156,251 @@ ] } }, + "/api/v1/entities/exportTemplates": { + "get": { + "operationId": "getAllEntities@ExportTemplates", + "parameters": [ + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "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/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "GET all Export Template entities", + "tags": [ + "entities", + "organization-model-controller" + ] + }, + "post": { + "operationId": "createEntity@ExportTemplates", + "requestBody": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Export Template entities", + "tags": [ + "entities", + "organization-model-controller" + ] + } + }, + "/api/v1/entities/exportTemplates/{id}": { + "delete": { + "operationId": "deleteEntity@ExportTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Export Template entity", + "tags": [ + "entities", + "organization-model-controller" + ] + }, + "get": { + "operationId": "getEntity@ExportTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "GET Export Template entity", + "tags": [ + "entities", + "organization-model-controller" + ] + }, + "patch": { + "operationId": "patchEntity@ExportTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch Export Template entity", + "tags": [ + "entities", + "organization-model-controller" + ] + }, + "put": { + "operationId": "updateEntity@ExportTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "PUT Export Template entity", + "tags": [ + "entities", + "organization-model-controller" + ] + } + }, "/api/v1/entities/identityProviders": { "get": { "operationId": "getAllEntities@IdentityProviders", @@ -34231,6 +35307,65 @@ } } }, + "/api/v1/layout/exportTemplates": { + "get": { + "description": "Gets complete layout of export templates.", + "operationId": "getExportTemplatesLayout", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeclarativeExportTemplates" + } + } + }, + "description": "Retrieved layout of all export templates." + } + }, + "summary": "Get all export templates layout", + "tags": [ + "layout", + "Notification Channels" + ], + "x-gdc-security-info": { + "description": "Permission required to get export templates layout.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "description": "Sets export templates in organization.", + "operationId": "setExportTemplates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeclarativeExportTemplates" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "All export templates set." + } + }, + "summary": "Set all export templates", + "tags": [ + "layout", + "Notification Channels" + ], + "x-gdc-security-info": { + "description": "Permission required to set export templates layout.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/layout/identityProviders": { "get": { "description": "Gets complete layout of identity providers.", From 92bbdf82336a16ee84f24e19cc0e0a5e58d96906 Mon Sep 17 00:00:00 2001 From: Jan Kadlec Date: Fri, 11 Apr 2025 13:18:19 +0200 Subject: [PATCH 2/3] feat: add support for slides export JIRA: F1-1268 risk: low --- gooddata-sdk/gooddata_sdk/__init__.py | 1 + .../gooddata_sdk/catalog/export/request.py | 31 ++++++++++++++++- .../gooddata_sdk/catalog/export/service.py | 34 ++++++++++++++++++- 3 files changed, 64 insertions(+), 2 deletions(-) diff --git a/gooddata-sdk/gooddata_sdk/__init__.py b/gooddata-sdk/gooddata_sdk/__init__.py index 74d341e6e..0a2ae28d6 100644 --- a/gooddata-sdk/gooddata_sdk/__init__.py +++ b/gooddata-sdk/gooddata_sdk/__init__.py @@ -66,6 +66,7 @@ ExportCustomOverride, ExportRequest, ExportSettings, + SlidesExportRequest, VisualExportRequest, ) from gooddata_sdk.catalog.filter_by import CatalogFilterBy diff --git a/gooddata-sdk/gooddata_sdk/catalog/export/request.py b/gooddata-sdk/gooddata_sdk/catalog/export/request.py index a750d58e5..d2a2a783f 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/export/request.py +++ b/gooddata-sdk/gooddata_sdk/catalog/export/request.py @@ -1,11 +1,12 @@ # (C) 2023 GoodData Corporation -from typing import Optional +from typing import Literal, Optional from attrs import define from gooddata_api_client.model.custom_label import CustomLabel as ApiCustomLabel from gooddata_api_client.model.custom_metric import CustomMetric as ApiCustomMetric from gooddata_api_client.model.custom_override import CustomOverride as ApiCustomOverride from gooddata_api_client.model.settings import Settings as ApiSettings +from gooddata_api_client.model.slides_export_request import SlidesExportRequest as SlidesExportRequestApi from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.visual_export_request import VisualExportRequest as VisualExportRequestApi @@ -121,3 +122,31 @@ def client_class() -> type[VisualExportRequestApi]: type[TabularExportRequest]: VisualExportRequest class """ return VisualExportRequestApi + + +@define(auto_attribs=True, kw_only=True) +class SlidesExportRequest(Base): + """ + SlidesExportRequest class is used to create a slide export request in the desired format, filename, and settings. + Attributes: + dashboard_id (str): Dashboard identifier. + file_name (str): File name to be used for retrieving the PDF document. + metadata (Optional[Dict[str, bool]]): Optional dictionary containing settings for the export request. + """ + + file_name: str + format: Literal["PDF", "PPTX"] + dashboard_id: Optional[str] = None + widget_ids: Optional[list[str]] = None + visualization_ids: Optional[list[str]] = None + metadata: Optional[dict] = None + templateId: Optional[str] = None + + @staticmethod + def client_class() -> type[SlidesExportRequestApi]: + """ + Returns the appropriate client class for the visual export request. + Returns: + type[SlidesExportRequestApi]: SlidesExportRequestApi class + """ + return SlidesExportRequestApi diff --git a/gooddata-sdk/gooddata_sdk/catalog/export/service.py b/gooddata-sdk/gooddata_sdk/catalog/export/service.py index 7952326f2..8774b3c98 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/export/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/export/service.py @@ -4,6 +4,7 @@ from typing import Any, Callable, Optional, Union from gooddata_api_client.exceptions import NotFoundException +from gooddata_api_client.model.slides_export_request import SlidesExportRequest as SlidesExportRequestApi from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.visual_export_request import VisualExportRequest @@ -11,6 +12,7 @@ from gooddata_sdk.catalog.export.request import ( ExportRequest, ExportSettings, + SlidesExportRequest, ) from gooddata_sdk.client import GoodDataApiClient from gooddata_sdk.visualization import VisualizationService @@ -140,7 +142,7 @@ def _dashboard_id_exists(self, workspace_id: str, dashboard_id: str) -> bool: def _export_common( self, workspace_id: str, - request: Union[VisualExportRequest, TabularExportRequest], + request: Union[VisualExportRequest, TabularExportRequest, SlidesExportRequestApi], file_path: Path, create_func: Callable, get_func: Callable, @@ -314,3 +316,33 @@ def export_tabular_by_visualization_id( retry=retry, max_retry=max_retry, ) + + def export_slides( + self, + workspace_id: str, + request: SlidesExportRequest, + store_path: Union[str, Path] = Path.cwd(), + timeout: float = 60.0, + retry: float = 0.2, + max_retry: float = 5.0, + ) -> None: + """ + Exports slides based on slide export request. + + Args: + workspace_id (str): The workspace id from which the visualization is to be exported. + request (SlidesExportRequest): The request object containing the export parameters. + store_path (Union[str, Path], optional): The path to store the exported file. Default to Path.cwd(). + timeout (float, optional): The maximum time to wait for the export to finish. Defaults to 60.0. + retry (float, optional): + Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2. + max_retry (float, optional): The maximum retry wait time (in seconds). Defaults to 5.0. + + Returns: + None + """ + store_path = store_path if isinstance(store_path, Path) else Path(store_path) + file_path = store_path / f"{request.file_name}.{request.format.lower()}" + create_func = self._actions_api.create_slides_export + get_func = self._actions_api.get_slides_export + self._export_common(workspace_id, request.to_api(), file_path, create_func, get_func, timeout, retry, max_retry) From 78510f8176102b9316919ce8474320f0bac6b90c Mon Sep 17 00:00:00 2001 From: Jan Kadlec Date: Fri, 11 Apr 2025 14:48:16 +0200 Subject: [PATCH 3/3] feat: add export template support JIRA: F1-1268 risk: low --- gooddata-sdk/gooddata_sdk/__init__.py | 16 +++ .../catalog/organization/common/__init__.py | 1 + .../common/dashboard_slides_template.py | 20 +++ .../organization/common/running_section.py | 10 ++ .../organization/common/slide_template.py | 38 ++++++ .../common/widget_slides_template.py | 12 ++ .../entity_model/export_template.py | 34 +++++ .../organization/layout/export_template.py | 22 ++++ .../catalog/organization/service.py | 119 ++++++++++++++++++ 9 files changed, 272 insertions(+) create mode 100644 gooddata-sdk/gooddata_sdk/catalog/organization/common/__init__.py create mode 100644 gooddata-sdk/gooddata_sdk/catalog/organization/common/dashboard_slides_template.py create mode 100644 gooddata-sdk/gooddata_sdk/catalog/organization/common/running_section.py create mode 100644 gooddata-sdk/gooddata_sdk/catalog/organization/common/slide_template.py create mode 100644 gooddata-sdk/gooddata_sdk/catalog/organization/common/widget_slides_template.py create mode 100644 gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/export_template.py create mode 100644 gooddata-sdk/gooddata_sdk/catalog/organization/layout/export_template.py diff --git a/gooddata-sdk/gooddata_sdk/__init__.py b/gooddata-sdk/gooddata_sdk/__init__.py index 0a2ae28d6..3b2a04785 100644 --- a/gooddata-sdk/gooddata_sdk/__init__.py +++ b/gooddata-sdk/gooddata_sdk/__init__.py @@ -79,7 +79,20 @@ CatalogUserIdentifier, CatalogWorkspaceIdentifier, ) +from gooddata_sdk.catalog.organization.common.dashboard_slides_template import CatalogDashboardSlidesTemplate +from gooddata_sdk.catalog.organization.common.running_section import CatalogRunningSection +from gooddata_sdk.catalog.organization.common.slide_template import ( + CatalogContentSlideTemplate, + CatalogCoverSlideTemplate, + CatalogIntroSlideTemplate, + CatalogSectionSlideTemplate, +) +from gooddata_sdk.catalog.organization.common.widget_slides_template import CatalogWidgetSlidesTemplate from gooddata_sdk.catalog.organization.entity_model.directive import CatalogCspDirective +from gooddata_sdk.catalog.organization.entity_model.export_template import ( + CatalogExportTemplate, + CatalogExportTemplateAttributes, +) from gooddata_sdk.catalog.organization.entity_model.jwk import ( CatalogJwk, CatalogJwkAttributes, @@ -88,6 +101,9 @@ ) from gooddata_sdk.catalog.organization.entity_model.organization import CatalogOrganization from gooddata_sdk.catalog.organization.entity_model.setting import CatalogOrganizationSetting +from gooddata_sdk.catalog.organization.layout.export_template import ( + CatalogDeclarativeExportTemplate, +) from gooddata_sdk.catalog.organization.layout.notification_channel import ( CatalogDeclarativeNotificationChannel, CatalogWebhook, diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/common/__init__.py b/gooddata-sdk/gooddata_sdk/catalog/organization/common/__init__.py new file mode 100644 index 000000000..37d863d60 --- /dev/null +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/common/__init__.py @@ -0,0 +1 @@ +# (C) 2025 GoodData Corporation diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/common/dashboard_slides_template.py b/gooddata-sdk/gooddata_sdk/catalog/organization/common/dashboard_slides_template.py new file mode 100644 index 000000000..726aca216 --- /dev/null +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/common/dashboard_slides_template.py @@ -0,0 +1,20 @@ +# (C) 2025 GoodData Corporation +from typing import Literal, Optional + +from attrs import define + +from gooddata_sdk.catalog.organization.common.slide_template import ( + CatalogContentSlideTemplate, + CatalogCoverSlideTemplate, + CatalogIntroSlideTemplate, + CatalogSectionSlideTemplate, +) + + +@define +class CatalogDashboardSlidesTemplate: + applied_on: list[Literal["PDF", "PPTX"]] + cover_slide: Optional[CatalogCoverSlideTemplate] = None + intro_slide: Optional[CatalogIntroSlideTemplate] = None + section_slide: Optional[CatalogSectionSlideTemplate] = None + content_slide: Optional[CatalogContentSlideTemplate] = None diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/common/running_section.py b/gooddata-sdk/gooddata_sdk/catalog/organization/common/running_section.py new file mode 100644 index 000000000..1fdfd65e7 --- /dev/null +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/common/running_section.py @@ -0,0 +1,10 @@ +# (C) 2025 GoodData Corporation +from typing import Optional + +from attrs import define + + +@define +class CatalogRunningSection: + left: Optional[str] = None + right: Optional[str] = None diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/common/slide_template.py b/gooddata-sdk/gooddata_sdk/catalog/organization/common/slide_template.py new file mode 100644 index 000000000..42af27bfa --- /dev/null +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/common/slide_template.py @@ -0,0 +1,38 @@ +# (C) 2025 GoodData Corporation +from typing import Optional + +from attrs import define + +from gooddata_sdk.catalog.base import Base +from gooddata_sdk.catalog.organization.common.running_section import CatalogRunningSection + + +@define +class CatalogCoverSlideTemplate(Base): + background_image: bool + description_field: Optional[str] = None + header: Optional[CatalogRunningSection] = None + footer: Optional[CatalogRunningSection] = None + + +@define +class CatalogIntroSlideTemplate(Base): + background_image: bool + title_field: Optional[str] = None + description_field: Optional[str] = None + header: Optional[CatalogRunningSection] = None + footer: Optional[CatalogRunningSection] = None + + +@define +class CatalogSectionSlideTemplate(Base): + background_image: bool + header: Optional[CatalogRunningSection] = None + footer: Optional[CatalogRunningSection] = None + + +@define +class CatalogContentSlideTemplate(Base): + description_field: Optional[str] = None + header: Optional[CatalogRunningSection] = None + footer: Optional[CatalogRunningSection] = None diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/common/widget_slides_template.py b/gooddata-sdk/gooddata_sdk/catalog/organization/common/widget_slides_template.py new file mode 100644 index 000000000..0db000922 --- /dev/null +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/common/widget_slides_template.py @@ -0,0 +1,12 @@ +# (C) 2025 GoodData Corporation +from typing import Literal, Optional + +from attrs import define + +from gooddata_sdk.catalog.organization.common.slide_template import CatalogContentSlideTemplate + + +@define +class CatalogWidgetSlidesTemplate: + applied_on: list[Literal["PDF", "PPTX"]] + content_slide: Optional[CatalogContentSlideTemplate] = None diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/export_template.py b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/export_template.py new file mode 100644 index 000000000..f66734682 --- /dev/null +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/entity_model/export_template.py @@ -0,0 +1,34 @@ +# (C) 2025 GoodData Corporation +from __future__ import annotations + +import builtins +from typing import Optional + +from attrs import define +from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes +from gooddata_api_client.model.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId + +from gooddata_sdk.catalog.base import Base +from gooddata_sdk.catalog.organization.common.dashboard_slides_template import CatalogDashboardSlidesTemplate +from gooddata_sdk.catalog.organization.common.widget_slides_template import CatalogWidgetSlidesTemplate + + +@define(auto_attribs=True, kw_only=True) +class CatalogExportTemplate(Base): + id: str + attributes: Optional[CatalogExportTemplateAttributes] = None + + @staticmethod + def client_class() -> builtins.type[JsonApiExportTemplatePostOptionalId]: + return JsonApiExportTemplatePostOptionalId + + +@define(auto_attribs=True, kw_only=True) +class CatalogExportTemplateAttributes(Base): + name: str + dashboard_slides_template: Optional[CatalogDashboardSlidesTemplate] = None + widget_slides_template: Optional[CatalogWidgetSlidesTemplate] = None + + @staticmethod + def client_class() -> builtins.type[JsonApiExportTemplateInAttributes]: + return JsonApiExportTemplateInAttributes diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/export_template.py b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/export_template.py new file mode 100644 index 000000000..ae1fb57dd --- /dev/null +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/export_template.py @@ -0,0 +1,22 @@ +# (C) 2025 GoodData Corporation +import builtins +from typing import Optional + +from attrs import define +from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate + +from gooddata_sdk.catalog.base import Base +from gooddata_sdk.catalog.organization.common.dashboard_slides_template import CatalogDashboardSlidesTemplate +from gooddata_sdk.catalog.organization.common.widget_slides_template import CatalogWidgetSlidesTemplate + + +@define +class CatalogDeclarativeExportTemplate(Base): + id: str + name: str + dashboard_slides_template: Optional[CatalogDashboardSlidesTemplate] = None + widget_slides_template: Optional[CatalogWidgetSlidesTemplate] = None + + @staticmethod + def client_class() -> builtins.type[DeclarativeExportTemplate]: + return DeclarativeExportTemplate diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/service.py b/gooddata-sdk/gooddata_sdk/catalog/organization/service.py index d7c9961cd..4806ba296 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/service.py @@ -5,11 +5,17 @@ from typing import Optional from gooddata_api_client.exceptions import NotFoundException +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument +from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.model.json_api_export_template_post_optional_id_document import ( + JsonApiExportTemplatePostOptionalIdDocument, +) from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument +from gooddata_sdk import CatalogDeclarativeExportTemplate, CatalogExportTemplate from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase from gooddata_sdk.catalog.organization.entity_model.directive import CatalogCspDirective from gooddata_sdk.catalog.organization.entity_model.identity_provider import CatalogIdentityProvider @@ -424,6 +430,86 @@ def patch_identity_provider_attributes(self, identity_provider_id: str, attribut identity_provider_id, CatalogIdentityProvider.to_api_patch(identity_provider_id, attributes) ) + def create_or_update_export_template(self, export_template: CatalogExportTemplate) -> None: + """Create a new export template or overwrite an existing export template with the same id. + + Args: + export_template (CatalogExportTemplate): + Catalog export template object to be created or updated. + + Returns: + None + + Raises: + ValueError: Export template cannot be updated. + """ + try: + self.get_export_template(export_template.id) + self._entities_api.update_entity_export_templates( + id=export_template.id, + json_api_export_template_in_document=JsonApiExportTemplateInDocument.from_dict( + {"data": export_template.to_dict()} + ), + ) + except NotFoundException: + self._entities_api.create_entity_export_templates( + json_api_export_template_post_optional_id_document=JsonApiExportTemplatePostOptionalIdDocument( + data=export_template.to_api() + ) + ) + + def get_export_template(self, export_template_id: str) -> CatalogExportTemplate: + """Get an individual export template. + + Args: + export_template_id (str): + Export template identification string e.g. "demo" + + Returns: + CatalogJwk: + Catalog export template object containing the structure of the export template. + """ + export_template_api = self._entities_api.get_entity_export_templates(id=export_template_id).data + return CatalogExportTemplate.from_api(export_template_api) + + def delete_export_template(self, export_template_id: str) -> None: + """Delete an export template. + + Args: + export_template_id (str): + Export template identification string e.g. "demo" + + Returns: + None + + Raises: + ValueError: + Export template does not exist. + """ + try: + self._entities_api.delete_entity_export_templates(export_template_id) + except NotFoundException: + raise ValueError( + f"Can not delete {export_template_id} export template. This export template does not exist." + ) + + def list_export_templates(self) -> list[CatalogExportTemplate]: + """Returns a list of all export templates in the current organization. + + Returns: + list[CatalogExportTemplate]: + List of export templates in the current organization. + """ + get_export_templates = functools.partial( + self._entities_api.get_all_entities_export_templates, + _check_return_type=False, + ) + export_templates = load_all_entities_dict(get_export_templates, camel_case=False) + return [ + CatalogExportTemplate.from_dict(export_template, camel_case=False) + for export_template in export_templates["data"] + ] + # Layout APIs def get_declarative_notification_channels(self) -> list[CatalogDeclarativeNotificationChannel]: @@ -480,3 +566,36 @@ def put_declarative_identity_providers(self, identity_providers: list[CatalogDec """ api_idps = [idp.to_api() for idp in identity_providers] self._layout_api.set_identity_providers(declarative_identity_provider=api_idps) + + def get_declarative_export_templates(self) -> list[CatalogDeclarativeExportTemplate]: + """ + Get all declarative export templates in the current organization. + + Returns: + list[CatalogDeclarativeExportTemplate]: + List of declarative export templates. + """ + export_templates_api = self._layout_api.get_export_templates_layout() + if hasattr(export_templates_api, "export_templates"): + return [ + CatalogDeclarativeExportTemplate.from_api(template) + for template in export_templates_api.export_templates + ] + else: + return [] + + def put_declarative_export_templates(self, export_templates: list[CatalogDeclarativeExportTemplate]) -> None: + """ + Put declarative export templates in the current organization. + + Args: + export_templates (list[CatalogDeclarativeExportTemplate]): + List of declarative export templates. + + Returns: + None + """ + api_export_templates = [export_template.to_api() for export_template in export_templates] + self._layout_api.set_export_templates( + declarative_export_templates=DeclarativeExportTemplates(export_templates=api_export_templates) + )