From b27c38d69a133b43396969de4139439b1758c7e4 Mon Sep 17 00:00:00 2001 From: Dan Homola Date: Fri, 5 Sep 2025 13:41:10 +0200 Subject: [PATCH] chore: re-generate api-client This version has better types for the export results. JIRA: CQ-1174 risk: low --- gooddata-api-client/.openapi-generator/FILES | 24 +- gooddata-api-client/README.md | 34 +- gooddata-api-client/docs/ActionsApi.md | 659 +++++++- gooddata-api-client/docs/AttributeFormat.md | 1 + ...AutomationOrganizationViewControllerApi.md | 91 ++ gooddata-api-client/docs/AutomationsApi.md | 616 ++++++- gooddata-api-client/docs/EntitiesApi.md | 102 +- gooddata-api-client/docs/ImageExportApi.md | 7 +- .../docs/JsonApiAutomationOutRelationships.md | 2 +- ...ationOutRelationshipsAutomationResults.md} | 2 +- .../JsonApiAutomationResultOutAttributes.md | 2 + .../docs/JsonApiWorkspaceAutomationOut.md | 16 + ...JsonApiWorkspaceAutomationOutAttributes.md | 30 + .../docs/JsonApiWorkspaceAutomationOutList.md | 16 + .../JsonApiWorkspaceAutomationOutWithLinks.md | 16 + gooddata-api-client/docs/LayoutApi.md | 9 + .../docs/OrganizationAutomationIdentifier.md | 13 + ...nizationAutomationManagementBulkRequest.md | 12 + .../docs/OrganizationDeclarativeAPIsApi.md | 3 + gooddata-api-client/docs/RawExportApi.md | 7 +- gooddata-api-client/docs/Settings.md | 3 + gooddata-api-client/docs/SlidesExportApi.md | 18 +- gooddata-api-client/docs/SmartFunctionsApi.md | 88 +- gooddata-api-client/docs/TabularExportApi.md | 10 +- .../docs/ValidateLLMEndpointByIdRequest.md | 16 + gooddata-api-client/docs/VisualExportApi.md | 18 +- .../docs/WorkspaceAutomationIdentifier.md | 12 + ...orkspaceAutomationManagementBulkRequest.md | 12 + .../docs/WorkspaceObjectControllerApi.md | 19 +- .../docs/WorkspacesDeclarativeAPIsApi.md | 3 + .../gooddata_api_client/api/actions_api.py | 1396 ++++++++++++++-- ...mation_organization_view_controller_api.py | 224 +++ .../api/automations_api.py | 1419 +++++++++++++++-- .../gooddata_api_client/api/entities_api.py | 191 ++- .../api/image_export_api.py | 4 +- .../gooddata_api_client/api/raw_export_api.py | 4 +- .../api/slides_export_api.py | 10 +- .../api/smart_functions_api.py | 142 +- .../api/tabular_export_api.py | 4 +- .../api/visual_export_api.py | 10 +- .../api/workspace_object_controller_api.py | 5 - .../gooddata_api_client/apis/__init__.py | 1 + .../model/api_entitlement.py | 1 + .../model/attribute_format.py | 4 + .../model/declarative_setting.py | 2 + .../model/entitlements_request.py | 1 + .../json_api_automation_out_relationships.py | 12 +- ...n_out_relationships_automation_results.py} | 6 +- ...on_api_automation_result_out_attributes.py | 14 + ..._api_organization_setting_in_attributes.py | 2 + .../json_api_workspace_automation_out.py | 304 ++++ ...api_workspace_automation_out_attributes.py | 381 +++++ .../json_api_workspace_automation_out_list.py | 298 ++++ ...api_workspace_automation_out_with_links.py | 355 +++++ .../organization_automation_identifier.py | 276 ++++ ...tion_automation_management_bulk_request.py | 276 ++++ .../model/resolved_setting.py | 2 + .../gooddata_api_client/model/settings.py | 21 + .../validate_llm_endpoint_by_id_request.py | 280 ++++ .../model/workspace_automation_identifier.py | 270 ++++ ...pace_automation_management_bulk_request.py | 276 ++++ .../gooddata_api_client/models/__init__.py | 11 +- schemas/gooddata-afm-client.json | 73 +- schemas/gooddata-api-client.json | 1013 +++++++++++- schemas/gooddata-automation-client.json | 30 + schemas/gooddata-export-client.json | 125 +- schemas/gooddata-metadata-client.json | 971 ++++++++++- 67 files changed, 9770 insertions(+), 505 deletions(-) create mode 100644 gooddata-api-client/docs/AutomationOrganizationViewControllerApi.md rename gooddata-api-client/docs/{JsonApiAutomationOutRelationshipsAutomationResult.md => JsonApiAutomationOutRelationshipsAutomationResults.md} (91%) create mode 100644 gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md create mode 100644 gooddata-api-client/docs/JsonApiWorkspaceAutomationOutAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiWorkspaceAutomationOutList.md create mode 100644 gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md create mode 100644 gooddata-api-client/docs/OrganizationAutomationIdentifier.md create mode 100644 gooddata-api-client/docs/OrganizationAutomationManagementBulkRequest.md create mode 100644 gooddata-api-client/docs/ValidateLLMEndpointByIdRequest.md create mode 100644 gooddata-api-client/docs/WorkspaceAutomationIdentifier.md create mode 100644 gooddata-api-client/docs/WorkspaceAutomationManagementBulkRequest.md create mode 100644 gooddata-api-client/gooddata_api_client/api/automation_organization_view_controller_api.py rename gooddata-api-client/gooddata_api_client/model/{json_api_automation_out_relationships_automation_result.py => json_api_automation_out_relationships_automation_results.py} (97%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py create mode 100644 gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.py create mode 100644 gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.py create mode 100644 gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.py create mode 100644 gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.py create mode 100644 gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.py diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 2f021d7ba..bfc18ed3e 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -71,6 +71,7 @@ docs/AutomationImageExport.md docs/AutomationMetadata.md docs/AutomationNotification.md docs/AutomationNotificationAllOf.md +docs/AutomationOrganizationViewControllerApi.md docs/AutomationRawExport.md docs/AutomationSchedule.md docs/AutomationSlidesExport.md @@ -407,7 +408,7 @@ docs/JsonApiAutomationOutDocument.md docs/JsonApiAutomationOutIncludes.md docs/JsonApiAutomationOutList.md docs/JsonApiAutomationOutRelationships.md -docs/JsonApiAutomationOutRelationshipsAutomationResult.md +docs/JsonApiAutomationOutRelationshipsAutomationResults.md docs/JsonApiAutomationOutWithLinks.md docs/JsonApiAutomationPatch.md docs/JsonApiAutomationPatchDocument.md @@ -764,6 +765,10 @@ docs/JsonApiVisualizationObjectPostOptionalId.md docs/JsonApiVisualizationObjectPostOptionalIdDocument.md docs/JsonApiVisualizationObjectToManyLinkage.md docs/JsonApiVisualizationObjectToOneLinkage.md +docs/JsonApiWorkspaceAutomationOut.md +docs/JsonApiWorkspaceAutomationOutAttributes.md +docs/JsonApiWorkspaceAutomationOutList.md +docs/JsonApiWorkspaceAutomationOutWithLinks.md docs/JsonApiWorkspaceDataFilterIn.md docs/JsonApiWorkspaceDataFilterInAttributes.md docs/JsonApiWorkspaceDataFilterInDocument.md @@ -864,6 +869,8 @@ docs/ObjectLinks.md docs/ObjectLinksContainer.md docs/OptionsApi.md docs/OrganizationApi.md +docs/OrganizationAutomationIdentifier.md +docs/OrganizationAutomationManagementBulkRequest.md docs/OrganizationControllerApi.md docs/OrganizationDeclarativeAPIsApi.md docs/OrganizationEntityAPIsApi.md @@ -1006,6 +1013,7 @@ docs/UserSettingsApi.md docs/UsersDeclarativeAPIsApi.md docs/UsersEntityAPIsApi.md docs/ValidateByItem.md +docs/ValidateLLMEndpointByIdRequest.md docs/ValidateLLMEndpointRequest.md docs/ValidateLLMEndpointResponse.md docs/Value.md @@ -1020,6 +1028,8 @@ docs/WebhookMessage.md docs/WebhookMessageData.md docs/WebhookRecipient.md docs/WidgetSlidesTemplate.md +docs/WorkspaceAutomationIdentifier.md +docs/WorkspaceAutomationManagementBulkRequest.md docs/WorkspaceDataSource.md docs/WorkspaceIdentifier.md docs/WorkspaceObjectControllerApi.md @@ -1041,6 +1051,7 @@ gooddata_api_client/api/api_tokens_api.py gooddata_api_client/api/appearance_api.py gooddata_api_client/api/attribute_hierarchies_api.py gooddata_api_client/api/attributes_api.py +gooddata_api_client/api/automation_organization_view_controller_api.py gooddata_api_client/api/automations_api.py gooddata_api_client/api/available_drivers_api.py gooddata_api_client/api/computation_api.py @@ -1486,7 +1497,7 @@ gooddata_api_client/model/json_api_automation_out_document.py gooddata_api_client/model/json_api_automation_out_includes.py gooddata_api_client/model/json_api_automation_out_list.py gooddata_api_client/model/json_api_automation_out_relationships.py -gooddata_api_client/model/json_api_automation_out_relationships_automation_result.py +gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py gooddata_api_client/model/json_api_automation_out_with_links.py gooddata_api_client/model/json_api_automation_patch.py gooddata_api_client/model/json_api_automation_patch_document.py @@ -1843,6 +1854,10 @@ gooddata_api_client/model/json_api_visualization_object_post_optional_id.py gooddata_api_client/model/json_api_visualization_object_post_optional_id_document.py gooddata_api_client/model/json_api_visualization_object_to_many_linkage.py gooddata_api_client/model/json_api_visualization_object_to_one_linkage.py +gooddata_api_client/model/json_api_workspace_automation_out.py +gooddata_api_client/model/json_api_workspace_automation_out_attributes.py +gooddata_api_client/model/json_api_workspace_automation_out_list.py +gooddata_api_client/model/json_api_workspace_automation_out_with_links.py gooddata_api_client/model/json_api_workspace_data_filter_in.py gooddata_api_client/model/json_api_workspace_data_filter_in_attributes.py gooddata_api_client/model/json_api_workspace_data_filter_in_document.py @@ -1933,6 +1948,8 @@ gooddata_api_client/model/notifications_meta.py gooddata_api_client/model/notifications_meta_total.py gooddata_api_client/model/object_links.py gooddata_api_client/model/object_links_container.py +gooddata_api_client/model/organization_automation_identifier.py +gooddata_api_client/model/organization_automation_management_bulk_request.py gooddata_api_client/model/organization_permission_assignment.py gooddata_api_client/model/over.py gooddata_api_client/model/page_metadata.py @@ -2051,6 +2068,7 @@ gooddata_api_client/model/user_management_users_item.py gooddata_api_client/model/user_management_workspace_permission_assignment.py gooddata_api_client/model/user_permission.py gooddata_api_client/model/validate_by_item.py +gooddata_api_client/model/validate_llm_endpoint_by_id_request.py gooddata_api_client/model/validate_llm_endpoint_request.py gooddata_api_client/model/validate_llm_endpoint_response.py gooddata_api_client/model/value.py @@ -2063,6 +2081,8 @@ 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_automation_identifier.py +gooddata_api_client/model/workspace_automation_management_bulk_request.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 c8eae3bc4..f8830cbcb 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -107,15 +107,23 @@ Class | Method | HTTP request | Description *AttributesApi* | [**get_entity_attributes**](docs/AttributesApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute *AutomationsApi* | [**create_entity_automations**](docs/AutomationsApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations *AutomationsApi* | [**delete_entity_automations**](docs/AutomationsApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation +*AutomationsApi* | [**delete_organization_automations**](docs/AutomationsApi.md#delete_organization_automations) | **POST** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces +*AutomationsApi* | [**delete_workspace_automations**](docs/AutomationsApi.md#delete_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace +*AutomationsApi* | [**get_all_automations_workspace_automations**](docs/AutomationsApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces *AutomationsApi* | [**get_all_entities_automations**](docs/AutomationsApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations *AutomationsApi* | [**get_automations**](docs/AutomationsApi.md#get_automations) | **GET** /api/v1/layout/workspaces/{workspaceId}/automations | Get automations *AutomationsApi* | [**get_entity_automations**](docs/AutomationsApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation *AutomationsApi* | [**patch_entity_automations**](docs/AutomationsApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation +*AutomationsApi* | [**pause_organization_automations**](docs/AutomationsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces +*AutomationsApi* | [**pause_workspace_automations**](docs/AutomationsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace *AutomationsApi* | [**set_automations**](docs/AutomationsApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations *AutomationsApi* | [**trigger_automation**](docs/AutomationsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. *AutomationsApi* | [**trigger_existing_automation**](docs/AutomationsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. +*AutomationsApi* | [**unpause_organization_automations**](docs/AutomationsApi.md#unpause_organization_automations) | **POST** /api/v1/actions/organization/automations/unpause | Unpause selected automations across all workspaces +*AutomationsApi* | [**unpause_workspace_automations**](docs/AutomationsApi.md#unpause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unpause | Unpause selected automations in the workspace *AutomationsApi* | [**unsubscribe_all_automations**](docs/AutomationsApi.md#unsubscribe_all_automations) | **DELETE** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces *AutomationsApi* | [**unsubscribe_automation**](docs/AutomationsApi.md#unsubscribe_automation) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation +*AutomationsApi* | [**unsubscribe_selected_workspace_automations**](docs/AutomationsApi.md#unsubscribe_selected_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace *AutomationsApi* | [**unsubscribe_workspace_automations**](docs/AutomationsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace *AutomationsApi* | [**update_entity_automations**](docs/AutomationsApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation *AvailableDriversApi* | [**get_data_source_drivers**](docs/AvailableDriversApi.md#get_data_source_drivers) | **GET** /api/v1/options/availableDrivers | Get all available data source drivers @@ -327,7 +335,8 @@ Class | Method | HTTP request | Description *SmartFunctionsApi* | [**forecast**](docs/SmartFunctionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast *SmartFunctionsApi* | [**forecast_result**](docs/SmartFunctionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result *SmartFunctionsApi* | [**resolve_llm_endpoints**](docs/SmartFunctionsApi.md#resolve_llm_endpoints) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace -*SmartFunctionsApi* | [**validate_llm_endpoint**](docs/SmartFunctionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/validateLlmEndpoint | Validate LLM Endpoint +*SmartFunctionsApi* | [**validate_llm_endpoint**](docs/SmartFunctionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint +*SmartFunctionsApi* | [**validate_llm_endpoint_by_id**](docs/SmartFunctionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id *TabularExportApi* | [**create_dashboard_export_request**](docs/TabularExportApi.md#create_dashboard_export_request) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular | (EXPERIMENTAL) Create dashboard tabular export request *TabularExportApi* | [**create_tabular_export**](docs/TabularExportApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request *TabularExportApi* | [**get_tabular_export**](docs/TabularExportApi.md#get_tabular_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} | Retrieve exported files @@ -437,6 +446,8 @@ Class | Method | HTTP request | Description *ActionsApi* | [**create_slides_export**](docs/ActionsApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request *ActionsApi* | [**create_tabular_export**](docs/ActionsApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request *ActionsApi* | [**dashboard_permissions**](docs/ActionsApi.md#dashboard_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions | Get Dashboard Permissions +*ActionsApi* | [**delete_organization_automations**](docs/ActionsApi.md#delete_organization_automations) | **POST** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces +*ActionsApi* | [**delete_workspace_automations**](docs/ActionsApi.md#delete_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace *ActionsApi* | [**explain_afm**](docs/ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource. *ActionsApi* | [**forecast**](docs/ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast *ActionsApi* | [**forecast_result**](docs/ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result @@ -470,6 +481,8 @@ Class | Method | HTTP request | Description *ActionsApi* | [**metadata_sync_organization**](docs/ActionsApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services *ActionsApi* | [**overridden_child_entities**](docs/ActionsApi.md#overridden_child_entities) | **GET** /api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities | Finds identifier overrides in workspace hierarchy. *ActionsApi* | [**particular_platform_usage**](docs/ActionsApi.md#particular_platform_usage) | **POST** /api/v1/actions/collectUsage | Info about the platform usage for particular items. +*ActionsApi* | [**pause_organization_automations**](docs/ActionsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces +*ActionsApi* | [**pause_workspace_automations**](docs/ActionsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace *ActionsApi* | [**register_upload_notification**](docs/ActionsApi.md#register_upload_notification) | **POST** /api/v1/actions/dataSources/{dataSourceId}/uploadNotification | Register an upload notification *ActionsApi* | [**resolve_all_entitlements**](docs/ActionsApi.md#resolve_all_entitlements) | **GET** /api/v1/actions/resolveEntitlements | Values for all public entitlements. *ActionsApi* | [**resolve_all_settings_without_workspace**](docs/ActionsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. @@ -489,12 +502,17 @@ Class | Method | HTTP request | Description *ActionsApi* | [**test_notification_channel**](docs/ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel. *ActionsApi* | [**trigger_automation**](docs/ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. *ActionsApi* | [**trigger_existing_automation**](docs/ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. +*ActionsApi* | [**unpause_organization_automations**](docs/ActionsApi.md#unpause_organization_automations) | **POST** /api/v1/actions/organization/automations/unpause | Unpause selected automations across all workspaces +*ActionsApi* | [**unpause_workspace_automations**](docs/ActionsApi.md#unpause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unpause | Unpause selected automations in the workspace *ActionsApi* | [**unsubscribe_all_automations**](docs/ActionsApi.md#unsubscribe_all_automations) | **DELETE** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces *ActionsApi* | [**unsubscribe_automation**](docs/ActionsApi.md#unsubscribe_automation) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation +*ActionsApi* | [**unsubscribe_selected_workspace_automations**](docs/ActionsApi.md#unsubscribe_selected_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace *ActionsApi* | [**unsubscribe_workspace_automations**](docs/ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace -*ActionsApi* | [**validate_llm_endpoint**](docs/ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/validateLlmEndpoint | Validate LLM Endpoint +*ActionsApi* | [**validate_llm_endpoint**](docs/ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint +*ActionsApi* | [**validate_llm_endpoint_by_id**](docs/ActionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id *ActionsApi* | [**workspace_resolve_all_settings**](docs/ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. *ActionsApi* | [**workspace_resolve_settings**](docs/ActionsApi.md#workspace_resolve_settings) | **POST** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for selected settings. +*AutomationOrganizationViewControllerApi* | [**get_all_automations_workspace_automations**](docs/AutomationOrganizationViewControllerApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces *EntitiesApi* | [**create_entity_analytical_dashboards**](docs/EntitiesApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards *EntitiesApi* | [**create_entity_api_tokens**](docs/EntitiesApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user *EntitiesApi* | [**create_entity_attribute_hierarchies**](docs/EntitiesApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies @@ -553,6 +571,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_workspace_data_filters**](docs/EntitiesApi.md#delete_entity_workspace_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Delete a Workspace Data Filter *EntitiesApi* | [**delete_entity_workspace_settings**](docs/EntitiesApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace *EntitiesApi* | [**delete_entity_workspaces**](docs/EntitiesApi.md#delete_entity_workspaces) | **DELETE** /api/v1/entities/workspaces/{id} | Delete Workspace entity +*EntitiesApi* | [**get_all_automations_workspace_automations**](docs/EntitiesApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces *EntitiesApi* | [**get_all_entities_aggregated_facts**](docs/EntitiesApi.md#get_all_entities_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts | *EntitiesApi* | [**get_all_entities_analytical_dashboards**](docs/EntitiesApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards *EntitiesApi* | [**get_all_entities_api_tokens**](docs/EntitiesApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user @@ -1310,7 +1329,7 @@ Class | Method | HTTP request | Description - [JsonApiAutomationOutIncludes](docs/JsonApiAutomationOutIncludes.md) - [JsonApiAutomationOutList](docs/JsonApiAutomationOutList.md) - [JsonApiAutomationOutRelationships](docs/JsonApiAutomationOutRelationships.md) - - [JsonApiAutomationOutRelationshipsAutomationResult](docs/JsonApiAutomationOutRelationshipsAutomationResult.md) + - [JsonApiAutomationOutRelationshipsAutomationResults](docs/JsonApiAutomationOutRelationshipsAutomationResults.md) - [JsonApiAutomationOutWithLinks](docs/JsonApiAutomationOutWithLinks.md) - [JsonApiAutomationPatch](docs/JsonApiAutomationPatch.md) - [JsonApiAutomationPatchDocument](docs/JsonApiAutomationPatchDocument.md) @@ -1667,6 +1686,10 @@ Class | Method | HTTP request | Description - [JsonApiVisualizationObjectPostOptionalIdDocument](docs/JsonApiVisualizationObjectPostOptionalIdDocument.md) - [JsonApiVisualizationObjectToManyLinkage](docs/JsonApiVisualizationObjectToManyLinkage.md) - [JsonApiVisualizationObjectToOneLinkage](docs/JsonApiVisualizationObjectToOneLinkage.md) + - [JsonApiWorkspaceAutomationOut](docs/JsonApiWorkspaceAutomationOut.md) + - [JsonApiWorkspaceAutomationOutAttributes](docs/JsonApiWorkspaceAutomationOutAttributes.md) + - [JsonApiWorkspaceAutomationOutList](docs/JsonApiWorkspaceAutomationOutList.md) + - [JsonApiWorkspaceAutomationOutWithLinks](docs/JsonApiWorkspaceAutomationOutWithLinks.md) - [JsonApiWorkspaceDataFilterIn](docs/JsonApiWorkspaceDataFilterIn.md) - [JsonApiWorkspaceDataFilterInAttributes](docs/JsonApiWorkspaceDataFilterInAttributes.md) - [JsonApiWorkspaceDataFilterInDocument](docs/JsonApiWorkspaceDataFilterInDocument.md) @@ -1757,6 +1780,8 @@ Class | Method | HTTP request | Description - [NotificationsMetaTotal](docs/NotificationsMetaTotal.md) - [ObjectLinks](docs/ObjectLinks.md) - [ObjectLinksContainer](docs/ObjectLinksContainer.md) + - [OrganizationAutomationIdentifier](docs/OrganizationAutomationIdentifier.md) + - [OrganizationAutomationManagementBulkRequest](docs/OrganizationAutomationManagementBulkRequest.md) - [OrganizationPermissionAssignment](docs/OrganizationPermissionAssignment.md) - [Over](docs/Over.md) - [PageMetadata](docs/PageMetadata.md) @@ -1875,6 +1900,7 @@ Class | Method | HTTP request | Description - [UserManagementWorkspacePermissionAssignment](docs/UserManagementWorkspacePermissionAssignment.md) - [UserPermission](docs/UserPermission.md) - [ValidateByItem](docs/ValidateByItem.md) + - [ValidateLLMEndpointByIdRequest](docs/ValidateLLMEndpointByIdRequest.md) - [ValidateLLMEndpointRequest](docs/ValidateLLMEndpointRequest.md) - [ValidateLLMEndpointResponse](docs/ValidateLLMEndpointResponse.md) - [Value](docs/Value.md) @@ -1887,6 +1913,8 @@ Class | Method | HTTP request | Description - [WebhookMessageData](docs/WebhookMessageData.md) - [WebhookRecipient](docs/WebhookRecipient.md) - [WidgetSlidesTemplate](docs/WidgetSlidesTemplate.md) + - [WorkspaceAutomationIdentifier](docs/WorkspaceAutomationIdentifier.md) + - [WorkspaceAutomationManagementBulkRequest](docs/WorkspaceAutomationManagementBulkRequest.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 026705e4d..e04f2df16 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -30,6 +30,8 @@ Method | HTTP request | Description [**create_slides_export**](ActionsApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request [**create_tabular_export**](ActionsApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request [**dashboard_permissions**](ActionsApi.md#dashboard_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions | Get Dashboard Permissions +[**delete_organization_automations**](ActionsApi.md#delete_organization_automations) | **POST** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces +[**delete_workspace_automations**](ActionsApi.md#delete_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace [**explain_afm**](ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource. [**forecast**](ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast [**forecast_result**](ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result @@ -63,6 +65,8 @@ Method | HTTP request | Description [**metadata_sync_organization**](ActionsApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services [**overridden_child_entities**](ActionsApi.md#overridden_child_entities) | **GET** /api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities | Finds identifier overrides in workspace hierarchy. [**particular_platform_usage**](ActionsApi.md#particular_platform_usage) | **POST** /api/v1/actions/collectUsage | Info about the platform usage for particular items. +[**pause_organization_automations**](ActionsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces +[**pause_workspace_automations**](ActionsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace [**register_upload_notification**](ActionsApi.md#register_upload_notification) | **POST** /api/v1/actions/dataSources/{dataSourceId}/uploadNotification | Register an upload notification [**resolve_all_entitlements**](ActionsApi.md#resolve_all_entitlements) | **GET** /api/v1/actions/resolveEntitlements | Values for all public entitlements. [**resolve_all_settings_without_workspace**](ActionsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. @@ -82,10 +86,14 @@ Method | HTTP request | Description [**test_notification_channel**](ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel. [**trigger_automation**](ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. [**trigger_existing_automation**](ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. +[**unpause_organization_automations**](ActionsApi.md#unpause_organization_automations) | **POST** /api/v1/actions/organization/automations/unpause | Unpause selected automations across all workspaces +[**unpause_workspace_automations**](ActionsApi.md#unpause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unpause | Unpause selected automations in the workspace [**unsubscribe_all_automations**](ActionsApi.md#unsubscribe_all_automations) | **DELETE** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces [**unsubscribe_automation**](ActionsApi.md#unsubscribe_automation) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation +[**unsubscribe_selected_workspace_automations**](ActionsApi.md#unsubscribe_selected_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace [**unsubscribe_workspace_automations**](ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace -[**validate_llm_endpoint**](ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/validateLlmEndpoint | Validate LLM Endpoint +[**validate_llm_endpoint**](ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint +[**validate_llm_endpoint_by_id**](ActionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id [**workspace_resolve_all_settings**](ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. [**workspace_resolve_settings**](ActionsApi.md#workspace_resolve_settings) | **POST** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for selected settings. @@ -1880,6 +1888,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", metadata={}, ) # VisualExportRequest | + x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: @@ -1888,6 +1897,15 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->create_pdf_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create visual - pdf export request + api_response = api_instance.create_pdf_export(workspace_id, visual_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->create_pdf_export: %s\n" % e) ``` @@ -1897,6 +1915,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **visual_export_request** | [**VisualExportRequest**](VisualExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type @@ -2080,6 +2099,7 @@ with gooddata_api_client.ApiClient() as api_client: "widget_ids_example", ], ) # SlidesExportRequest | + x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: @@ -2088,6 +2108,15 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->create_slides_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Create slides export request + api_response = api_instance.create_slides_export(workspace_id, slides_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->create_slides_export: %s\n" % e) ``` @@ -2097,6 +2126,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **slides_export_request** | [**SlidesExportRequest**](SlidesExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type @@ -2171,6 +2201,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -2186,6 +2218,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -2299,6 +2332,149 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **delete_organization_automations** +> delete_organization_automations(organization_automation_management_bulk_request) + +Delete selected automations across all workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ), + ], + ) # OrganizationAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Delete selected automations across all workspaces + api_instance.delete_organization_automations(organization_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->delete_organization_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_workspace_automations** +> delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + +Delete selected automations in the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ), + ], + ) # WorkspaceAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Delete selected automations in the workspace + api_instance.delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->delete_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **explain_afm** > explain_afm(workspace_id, afm_execution) @@ -2947,7 +3123,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_exported_file** -> get_exported_file(workspace_id, export_id) +> file_type get_exported_file(workspace_id, export_id) Retrieve exported files @@ -2978,7 +3154,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # Retrieve exported files - api_instance.get_exported_file(workspace_id, export_id) + api_response = api_instance.get_exported_file(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->get_exported_file: %s\n" % e) ``` @@ -2993,7 +3170,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization @@ -3015,7 +3192,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_image_export** -> get_image_export(workspace_id, export_id) +> file_type get_image_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -3047,7 +3224,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files - api_instance.get_image_export(workspace_id, export_id) + api_response = api_instance.get_image_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->get_image_export: %s\n" % e) ``` @@ -3062,7 +3240,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization @@ -3296,7 +3474,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_raw_export** -> get_raw_export(workspace_id, export_id) +> file_type get_raw_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -3327,7 +3505,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files - api_instance.get_raw_export(workspace_id, export_id) + api_response = api_instance.get_raw_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->get_raw_export: %s\n" % e) ``` @@ -3342,7 +3521,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization @@ -3364,7 +3543,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_slides_export** -> get_slides_export(workspace_id, export_id) +> file_type get_slides_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -3396,7 +3575,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files - api_instance.get_slides_export(workspace_id, export_id) + api_response = api_instance.get_slides_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->get_slides_export: %s\n" % e) ``` @@ -3411,7 +3591,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization @@ -3500,7 +3680,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_tabular_export** -> get_tabular_export(workspace_id, export_id) +> file_type get_tabular_export(workspace_id, export_id) Retrieve exported files @@ -3531,7 +3711,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # Retrieve exported files - api_instance.get_tabular_export(workspace_id, export_id) + api_response = api_instance.get_tabular_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->get_tabular_export: %s\n" % e) ``` @@ -3546,7 +3727,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization @@ -4798,6 +4979,149 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **pause_organization_automations** +> pause_organization_automations(organization_automation_management_bulk_request) + +Pause selected automations across all workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ), + ], + ) # OrganizationAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Pause selected automations across all workspaces + api_instance.pause_organization_automations(organization_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->pause_organization_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pause_workspace_automations** +> pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + +Pause selected automations in the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ), + ], + ) # WorkspaceAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Pause selected automations in the workspace + api_instance.pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->pause_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **register_upload_notification** > register_upload_notification(data_source_id) @@ -6319,6 +6643,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -6334,6 +6660,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -6461,6 +6788,149 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **unpause_organization_automations** +> unpause_organization_automations(organization_automation_management_bulk_request) + +Unpause selected automations across all workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ), + ], + ) # OrganizationAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Unpause selected automations across all workspaces + api_instance.unpause_organization_automations(organization_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->unpause_organization_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unpause_workspace_automations** +> unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + +Unpause selected automations in the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ), + ], + ) # WorkspaceAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Unpause selected automations in the workspace + api_instance.unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->unpause_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **unsubscribe_all_automations** > unsubscribe_all_automations() @@ -6577,6 +7047,78 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unsubscribe_selected_workspace_automations** +> unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + +Unsubscribe from selected automations in the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ), + ], + ) # WorkspaceAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Unsubscribe from selected automations in the workspace + api_instance.unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->unsubscribe_selected_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.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 | @@ -6714,6 +7256,91 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_llm_endpoint_by_id** +> ValidateLLMEndpointResponse validate_llm_endpoint_by_id(llm_endpoint_id) + +Validate LLM Endpoint By Id + +Validates existing LLM endpoint with provided parameters and updates it if they are valid. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + llm_endpoint_id = "llmEndpointId_example" # str | + validate_llm_endpoint_by_id_request = ValidateLLMEndpointByIdRequest( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="provider_example", + token="token_example", + ) # ValidateLLMEndpointByIdRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Validate LLM Endpoint By Id + api_response = api_instance.validate_llm_endpoint_by_id(llm_endpoint_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->validate_llm_endpoint_by_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Validate LLM Endpoint By Id + api_response = api_instance.validate_llm_endpoint_by_id(llm_endpoint_id, validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->validate_llm_endpoint_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **llm_endpoint_id** | **str**| | + **validate_llm_endpoint_by_id_request** | [**ValidateLLMEndpointByIdRequest**](ValidateLLMEndpointByIdRequest.md)| | [optional] + +### Return type + +[**ValidateLLMEndpointResponse**](ValidateLLMEndpointResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AttributeFormat.md b/gooddata-api-client/docs/AttributeFormat.md index a60ce0007..5b1519ef8 100644 --- a/gooddata-api-client/docs/AttributeFormat.md +++ b/gooddata-api-client/docs/AttributeFormat.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **locale** | **str** | Format locale code like 'en-US', 'cs-CZ', etc. | **pattern** | **str** | ICU formatting pattern like 'y', 'dd.MM.y', etc. | +**timezone** | **str** | Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationOrganizationViewControllerApi.md b/gooddata-api-client/docs/AutomationOrganizationViewControllerApi.md new file mode 100644 index 000000000..f3079c63e --- /dev/null +++ b/gooddata-api-client/docs/AutomationOrganizationViewControllerApi.md @@ -0,0 +1,91 @@ +# gooddata_api_client.AutomationOrganizationViewControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_automations_workspace_automations**](AutomationOrganizationViewControllerApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces + + +# **get_all_automations_workspace_automations** +> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() + +Get all Automations across all Workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automation_organization_view_controller_api +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automation_organization_view_controller_api.AutomationOrganizationViewControllerApi(api_client) + filter = "filter=workspaceId==someString;title==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + 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 Automations across all Workspaces + api_response = api_instance.get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationOrganizationViewControllerApi->get_all_automations_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceAutomationOutList**](JsonApiWorkspaceAutomationOutList.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 | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index 2bd3bcffe..6d62f5b9a 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -6,15 +6,23 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_entity_automations**](AutomationsApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations [**delete_entity_automations**](AutomationsApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation +[**delete_organization_automations**](AutomationsApi.md#delete_organization_automations) | **POST** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces +[**delete_workspace_automations**](AutomationsApi.md#delete_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace +[**get_all_automations_workspace_automations**](AutomationsApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces [**get_all_entities_automations**](AutomationsApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations [**get_automations**](AutomationsApi.md#get_automations) | **GET** /api/v1/layout/workspaces/{workspaceId}/automations | Get automations [**get_entity_automations**](AutomationsApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation [**patch_entity_automations**](AutomationsApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation +[**pause_organization_automations**](AutomationsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces +[**pause_workspace_automations**](AutomationsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace [**set_automations**](AutomationsApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations [**trigger_automation**](AutomationsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. [**trigger_existing_automation**](AutomationsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. +[**unpause_organization_automations**](AutomationsApi.md#unpause_organization_automations) | **POST** /api/v1/actions/organization/automations/unpause | Unpause selected automations across all workspaces +[**unpause_workspace_automations**](AutomationsApi.md#unpause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unpause | Unpause selected automations in the workspace [**unsubscribe_all_automations**](AutomationsApi.md#unsubscribe_all_automations) | **DELETE** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces [**unsubscribe_automation**](AutomationsApi.md#unsubscribe_automation) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation +[**unsubscribe_selected_workspace_automations**](AutomationsApi.md#unsubscribe_selected_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace [**unsubscribe_workspace_automations**](AutomationsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace [**update_entity_automations**](AutomationsApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation @@ -233,6 +241,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -248,6 +258,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -299,7 +310,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAutomationInDocument | include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ "metaInclude=origin,all", @@ -430,6 +441,231 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **delete_organization_automations** +> delete_organization_automations(organization_automation_management_bulk_request) + +Delete selected automations across all workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automations_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ), + ], + ) # OrganizationAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Delete selected automations across all workspaces + api_instance.delete_organization_automations(organization_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->delete_organization_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_workspace_automations** +> delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + +Delete selected automations in the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automations_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + workspace_id = "workspaceId_example" # str | + workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ), + ], + ) # WorkspaceAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Delete selected automations in the workspace + api_instance.delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->delete_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_automations_workspace_automations** +> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() + +Get all Automations across all Workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automations_api +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + filter = "filter=workspaceId==someString;title==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + 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 Automations across all Workspaces + api_response = api_instance.get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->get_all_automations_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceAutomationOutList**](JsonApiWorkspaceAutomationOutList.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 | +|-------------|-------------|------------------| +**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_automations** > JsonApiAutomationOutList get_all_entities_automations(workspace_id) @@ -459,7 +695,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 @@ -635,7 +871,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -909,6 +1145,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -924,6 +1162,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -976,7 +1215,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationPatchDocument | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set @@ -1030,6 +1269,149 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **pause_organization_automations** +> pause_organization_automations(organization_automation_management_bulk_request) + +Pause selected automations across all workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automations_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ), + ], + ) # OrganizationAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Pause selected automations across all workspaces + api_instance.pause_organization_automations(organization_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->pause_organization_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pause_workspace_automations** +> pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + +Pause selected automations in the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automations_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + workspace_id = "workspaceId_example" # str | + workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ), + ], + ) # WorkspaceAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Pause selected automations in the workspace + api_instance.pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->pause_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **set_automations** > set_automations(workspace_id, declarative_automation) @@ -1276,6 +1658,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -1291,6 +1675,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -1576,6 +1961,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -1591,6 +1978,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -1718,6 +2106,149 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **unpause_organization_automations** +> unpause_organization_automations(organization_automation_management_bulk_request) + +Unpause selected automations across all workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automations_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + organization_automation_management_bulk_request = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ), + ], + ) # OrganizationAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Unpause selected automations across all workspaces + api_instance.unpause_organization_automations(organization_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unpause_organization_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_automation_management_bulk_request** | [**OrganizationAutomationManagementBulkRequest**](OrganizationAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unpause_workspace_automations** +> unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + +Unpause selected automations in the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automations_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + workspace_id = "workspaceId_example" # str | + workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ), + ], + ) # WorkspaceAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Unpause selected automations in the workspace + api_instance.unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unpause_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **unsubscribe_all_automations** > unsubscribe_all_automations() @@ -1834,6 +2365,78 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unsubscribe_selected_workspace_automations** +> unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + +Unsubscribe from selected automations in the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automations_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + workspace_id = "workspaceId_example" # str | + workspace_automation_management_bulk_request = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ), + ], + ) # WorkspaceAutomationManagementBulkRequest | + + # example passing only required values which don't have defaults set + try: + # Unsubscribe from selected automations in the workspace + api_instance.unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unsubscribe_selected_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **workspace_automation_management_bulk_request** | [**WorkspaceAutomationManagementBulkRequest**](WorkspaceAutomationManagementBulkRequest.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 | @@ -2120,6 +2723,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -2135,6 +2740,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -2187,7 +2793,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationInDocument | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index 1208ad4de..5784f6ae5 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -62,6 +62,7 @@ Method | HTTP request | Description [**delete_entity_workspace_data_filters**](EntitiesApi.md#delete_entity_workspace_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Delete a Workspace Data Filter [**delete_entity_workspace_settings**](EntitiesApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace [**delete_entity_workspaces**](EntitiesApi.md#delete_entity_workspaces) | **DELETE** /api/v1/entities/workspaces/{id} | Delete Workspace entity +[**get_all_automations_workspace_automations**](EntitiesApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces [**get_all_entities_aggregated_facts**](EntitiesApi.md#get_all_entities_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts | [**get_all_entities_analytical_dashboards**](EntitiesApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards [**get_all_entities_api_tokens**](EntitiesApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user @@ -689,6 +690,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -704,6 +707,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -755,7 +759,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAutomationInDocument | include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ "metaInclude=origin,all", @@ -5339,6 +5343,88 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_all_automations_workspace_automations** +> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() + +Get all Automations across all Workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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=workspaceId==someString;title==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + 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 Automations across all Workspaces + api_response = api_instance.get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_automations_workspace_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceAutomationOutList**](JsonApiWorkspaceAutomationOutList.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 | +|-------------|-------------|------------------| +**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_aggregated_facts** > JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id) @@ -5838,7 +5924,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 @@ -9263,7 +9349,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -12591,6 +12677,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -12606,6 +12694,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -12658,7 +12747,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationPatchDocument | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set @@ -15749,6 +15838,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -15764,6 +15855,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -15816,7 +15908,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationInDocument | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/ImageExportApi.md b/gooddata-api-client/docs/ImageExportApi.md index ccd9b7b4d..52aa305f1 100644 --- a/gooddata-api-client/docs/ImageExportApi.md +++ b/gooddata-api-client/docs/ImageExportApi.md @@ -88,7 +88,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_image_export** -> get_image_export(workspace_id, export_id) +> file_type get_image_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -120,7 +120,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files - api_instance.get_image_export(workspace_id, export_id) + api_response = api_instance.get_image_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ImageExportApi->get_image_export: %s\n" % e) ``` @@ -135,7 +136,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization diff --git a/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md b/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md index c75b37456..faec77979 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] -**automation_result** | [**JsonApiAutomationOutRelationshipsAutomationResult**](JsonApiAutomationOutRelationshipsAutomationResult.md) | | [optional] +**automation_results** | [**JsonApiAutomationOutRelationshipsAutomationResults**](JsonApiAutomationOutRelationshipsAutomationResults.md) | | [optional] **created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] **export_definitions** | [**JsonApiAutomationInRelationshipsExportDefinitions**](JsonApiAutomationInRelationshipsExportDefinitions.md) | | [optional] **modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResult.md b/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResults.md similarity index 91% rename from gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResult.md rename to gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResults.md index 39e291631..a8743e1f1 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResult.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsAutomationResults.md @@ -1,4 +1,4 @@ -# JsonApiAutomationOutRelationshipsAutomationResult +# JsonApiAutomationOutRelationshipsAutomationResults ## Properties diff --git a/gooddata-api-client/docs/JsonApiAutomationResultOutAttributes.md b/gooddata-api-client/docs/JsonApiAutomationResultOutAttributes.md index 409843da6..925e91d99 100644 --- a/gooddata-api-client/docs/JsonApiAutomationResultOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationResultOutAttributes.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **executed_at** | **datetime** | Timestamp of the last automation run. | **status** | **str** | Status of the last automation run. | +**error_message** | **str** | | [optional] +**trace_id** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md new file mode 100644 index 000000000..b7b45d7d2 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceAutomationOut + +JSON:API representation of workspaceAutomation entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiWorkspaceAutomationOutAttributes**](JsonApiWorkspaceAutomationOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceAutomation" +**relationships** | [**JsonApiAutomationOutRelationships**](JsonApiAutomationOutRelationships.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/JsonApiWorkspaceAutomationOutAttributes.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutAttributes.md new file mode 100644 index 000000000..43a2d937d --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutAttributes.md @@ -0,0 +1,30 @@ +# JsonApiWorkspaceAutomationOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workspace_id** | **str** | ID of the workspace to which the automation belongs. | +**alert** | [**JsonApiAutomationInAttributesAlert**](JsonApiAutomationInAttributesAlert.md) | | [optional] +**are_relations_valid** | **bool** | | [optional] +**created_at** | **datetime** | | [optional] +**dashboard_tabular_exports** | [**[JsonApiAutomationInAttributesDashboardTabularExportsInner]**](JsonApiAutomationInAttributesDashboardTabularExportsInner.md) | | [optional] +**description** | **str** | | [optional] +**details** | **{str: (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] +**image_exports** | [**[JsonApiAutomationInAttributesImageExportsInner]**](JsonApiAutomationInAttributesImageExportsInner.md) | | [optional] +**metadata** | [**JsonApiAutomationInAttributesMetadata**](JsonApiAutomationInAttributesMetadata.md) | | [optional] +**modified_at** | **datetime** | | [optional] +**raw_exports** | [**[JsonApiAutomationInAttributesRawExportsInner]**](JsonApiAutomationInAttributesRawExportsInner.md) | | [optional] +**schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] +**slides_exports** | [**[JsonApiAutomationInAttributesSlidesExportsInner]**](JsonApiAutomationInAttributesSlidesExportsInner.md) | | [optional] +**state** | **str** | Current state of the automation. | [optional] +**tabular_exports** | [**[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**visual_exports** | [**[JsonApiAutomationInAttributesVisualExportsInner]**](JsonApiAutomationInAttributesVisualExportsInner.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/JsonApiWorkspaceAutomationOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutList.md new file mode 100644 index 000000000..d258b2260 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutList.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceAutomationOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiWorkspaceAutomationOutWithLinks]**](JsonApiWorkspaceAutomationOutWithLinks.md) | | +**included** | [**[JsonApiAutomationOutIncludes]**](JsonApiAutomationOutIncludes.md) | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | | [optional] +**meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md new file mode 100644 index 000000000..b6ca42006 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceAutomationOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiWorkspaceAutomationOutAttributes**](JsonApiWorkspaceAutomationOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceAutomation" +**relationships** | [**JsonApiAutomationOutRelationships**](JsonApiAutomationOutRelationships.md) | | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index 71fe33f49..ee4a1d5c7 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -2704,6 +2704,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -2719,6 +2721,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -4013,6 +4016,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -4028,6 +4033,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -5233,6 +5239,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -5248,6 +5256,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ diff --git a/gooddata-api-client/docs/OrganizationAutomationIdentifier.md b/gooddata-api-client/docs/OrganizationAutomationIdentifier.md new file mode 100644 index 000000000..7d84b5cf7 --- /dev/null +++ b/gooddata-api-client/docs/OrganizationAutomationIdentifier.md @@ -0,0 +1,13 @@ +# OrganizationAutomationIdentifier + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**workspace_id** | **str** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/OrganizationAutomationManagementBulkRequest.md b/gooddata-api-client/docs/OrganizationAutomationManagementBulkRequest.md new file mode 100644 index 000000000..4e434256e --- /dev/null +++ b/gooddata-api-client/docs/OrganizationAutomationManagementBulkRequest.md @@ -0,0 +1,12 @@ +# OrganizationAutomationManagementBulkRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**automations** | [**[OrganizationAutomationIdentifier]**](OrganizationAutomationIdentifier.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/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index 911082616..2099f8202 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -620,6 +620,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -635,6 +637,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ diff --git a/gooddata-api-client/docs/RawExportApi.md b/gooddata-api-client/docs/RawExportApi.md index d1d134189..15c387eea 100644 --- a/gooddata-api-client/docs/RawExportApi.md +++ b/gooddata-api-client/docs/RawExportApi.md @@ -127,7 +127,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_raw_export** -> get_raw_export(workspace_id, export_id) +> file_type get_raw_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -158,7 +158,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files - api_instance.get_raw_export(workspace_id, export_id) + api_response = api_instance.get_raw_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling RawExportApi->get_raw_export: %s\n" % e) ``` @@ -173,7 +174,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization diff --git a/gooddata-api-client/docs/Settings.md b/gooddata-api-client/docs/Settings.md index f2ee2b9a3..baf2032a3 100644 --- a/gooddata-api-client/docs/Settings.md +++ b/gooddata-api-client/docs/Settings.md @@ -7,11 +7,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **export_info** | **bool** | Include export info sheet in the exported file. Works only with `visualizationObject`. (XLSX) | [optional] if omitted the server will use the default value of False **merge_headers** | **bool** | Merge equal headers in neighbouring cells. (XLSX) | [optional] +**page_orientation** | **str** | Set page orientation. (PDF) | [optional] if omitted the server will use the default value of "PORTRAIT" +**page_size** | **str** | Set page size. (PDF) | [optional] if omitted the server will use the default value of "A4" **pdf_page_size** | **str** | Page size and orientation. (PDF) | [optional] **pdf_table_style** | [**[PdfTableStyle]**](PdfTableStyle.md) | Custom CSS styles for the table. (PDF, HTML) | [optional] **pdf_top_left_content** | **str** | Top left header content. (PDF) | [optional] **pdf_top_right_content** | **str** | Top right header content. (PDF) | [optional] **show_filters** | **bool** | Print applied filters on top of the document. (PDF/HTML when visualizationObject is given) | [optional] +**show_info_page** | **bool** | Show info page with export information. | [optional] if omitted the server will use the default value of False **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/SlidesExportApi.md b/gooddata-api-client/docs/SlidesExportApi.md index e40039898..a4c29a2b1 100644 --- a/gooddata-api-client/docs/SlidesExportApi.md +++ b/gooddata-api-client/docs/SlidesExportApi.md @@ -51,6 +51,7 @@ with gooddata_api_client.ApiClient() as api_client: "widget_ids_example", ], ) # SlidesExportRequest | + x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: @@ -59,6 +60,15 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling SlidesExportApi->create_slides_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Create slides export request + api_response = api_instance.create_slides_export(workspace_id, slides_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SlidesExportApi->create_slides_export: %s\n" % e) ``` @@ -68,6 +78,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **slides_export_request** | [**SlidesExportRequest**](SlidesExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type @@ -92,7 +103,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_slides_export** -> get_slides_export(workspace_id, export_id) +> file_type get_slides_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -124,7 +135,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (EXPERIMENTAL) Retrieve exported files - api_instance.get_slides_export(workspace_id, export_id) + api_response = api_instance.get_slides_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling SlidesExportApi->get_slides_export: %s\n" % e) ``` @@ -139,7 +151,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization diff --git a/gooddata-api-client/docs/SmartFunctionsApi.md b/gooddata-api-client/docs/SmartFunctionsApi.md index 591871733..ab565bdfc 100644 --- a/gooddata-api-client/docs/SmartFunctionsApi.md +++ b/gooddata-api-client/docs/SmartFunctionsApi.md @@ -16,7 +16,8 @@ Method | HTTP request | Description [**forecast**](SmartFunctionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast [**forecast_result**](SmartFunctionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result [**resolve_llm_endpoints**](SmartFunctionsApi.md#resolve_llm_endpoints) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace -[**validate_llm_endpoint**](SmartFunctionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/validateLlmEndpoint | Validate LLM Endpoint +[**validate_llm_endpoint**](SmartFunctionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint +[**validate_llm_endpoint_by_id**](SmartFunctionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id # **ai_chat** @@ -1061,3 +1062,88 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **validate_llm_endpoint_by_id** +> ValidateLLMEndpointResponse validate_llm_endpoint_by_id(llm_endpoint_id) + +Validate LLM Endpoint By Id + +Validates existing LLM endpoint with provided parameters and updates it if they are valid. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_functions_api.SmartFunctionsApi(api_client) + llm_endpoint_id = "llmEndpointId_example" # str | + validate_llm_endpoint_by_id_request = ValidateLLMEndpointByIdRequest( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="provider_example", + token="token_example", + ) # ValidateLLMEndpointByIdRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Validate LLM Endpoint By Id + api_response = api_instance.validate_llm_endpoint_by_id(llm_endpoint_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->validate_llm_endpoint_by_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Validate LLM Endpoint By Id + api_response = api_instance.validate_llm_endpoint_by_id(llm_endpoint_id, validate_llm_endpoint_by_id_request=validate_llm_endpoint_by_id_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->validate_llm_endpoint_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **llm_endpoint_id** | **str**| | + **validate_llm_endpoint_by_id_request** | [**ValidateLLMEndpointByIdRequest**](ValidateLLMEndpointByIdRequest.md)| | [optional] + +### Return type + +[**ValidateLLMEndpointResponse**](ValidateLLMEndpointResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/TabularExportApi.md b/gooddata-api-client/docs/TabularExportApi.md index 9f11a8f14..73bcfa1d8 100644 --- a/gooddata-api-client/docs/TabularExportApi.md +++ b/gooddata-api-client/docs/TabularExportApi.md @@ -145,6 +145,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -160,6 +162,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -207,7 +210,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_tabular_export** -> get_tabular_export(workspace_id, export_id) +> file_type get_tabular_export(workspace_id, export_id) Retrieve exported files @@ -238,7 +241,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # Retrieve exported files - api_instance.get_tabular_export(workspace_id, export_id) + api_response = api_instance.get_tabular_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling TabularExportApi->get_tabular_export: %s\n" % e) ``` @@ -253,7 +257,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization diff --git a/gooddata-api-client/docs/ValidateLLMEndpointByIdRequest.md b/gooddata-api-client/docs/ValidateLLMEndpointByIdRequest.md new file mode 100644 index 000000000..bec19e758 --- /dev/null +++ b/gooddata-api-client/docs/ValidateLLMEndpointByIdRequest.md @@ -0,0 +1,16 @@ +# ValidateLLMEndpointByIdRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**base_url** | **str** | Base URL for the LLM endpoint validation | [optional] +**llm_model** | **str** | LLM model for the LLM endpoint validation | [optional] +**llm_organization** | **str** | Organization name for the LLM endpoint validation | [optional] +**provider** | **str** | Provider for the LLM endpoint validation | [optional] +**token** | **str** | Token for the LLM endpoint validation | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/VisualExportApi.md b/gooddata-api-client/docs/VisualExportApi.md index d8ba776b3..526dc524b 100644 --- a/gooddata-api-client/docs/VisualExportApi.md +++ b/gooddata-api-client/docs/VisualExportApi.md @@ -43,6 +43,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", metadata={}, ) # VisualExportRequest | + x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: @@ -51,6 +52,15 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling VisualExportApi->create_pdf_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create visual - pdf export request + api_response = api_instance.create_pdf_export(workspace_id, visual_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualExportApi->create_pdf_export: %s\n" % e) ``` @@ -60,6 +70,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **visual_export_request** | [**VisualExportRequest**](VisualExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type @@ -84,7 +95,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_exported_file** -> get_exported_file(workspace_id, export_id) +> file_type get_exported_file(workspace_id, export_id) Retrieve exported files @@ -115,7 +126,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # Retrieve exported files - api_instance.get_exported_file(workspace_id, export_id) + api_response = api_instance.get_exported_file(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling VisualExportApi->get_exported_file: %s\n" % e) ``` @@ -130,7 +142,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization diff --git a/gooddata-api-client/docs/WorkspaceAutomationIdentifier.md b/gooddata-api-client/docs/WorkspaceAutomationIdentifier.md new file mode 100644 index 000000000..e44d9da14 --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceAutomationIdentifier.md @@ -0,0 +1,12 @@ +# WorkspaceAutomationIdentifier + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/WorkspaceAutomationManagementBulkRequest.md b/gooddata-api-client/docs/WorkspaceAutomationManagementBulkRequest.md new file mode 100644 index 000000000..926f0a5bd --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceAutomationManagementBulkRequest.md @@ -0,0 +1,12 @@ +# WorkspaceAutomationManagementBulkRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**automations** | [**[WorkspaceAutomationIdentifier]**](WorkspaceAutomationIdentifier.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/WorkspaceObjectControllerApi.md b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md index 34a68dd8b..5396e8c2f 100644 --- a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md @@ -512,6 +512,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -527,6 +529,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -578,7 +581,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAutomationInDocument | include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ "metaInclude=origin,all", @@ -3199,7 +3202,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 @@ -4981,7 +4984,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -6673,6 +6676,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -6688,6 +6693,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -6740,7 +6746,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationPatchDocument | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set @@ -8315,6 +8321,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -8330,6 +8338,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ @@ -8382,7 +8391,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationInDocument | filter = "filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index 3a57f4901..2a0f378a8 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -786,6 +786,8 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( export_info=True, merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", pdf_page_size="a4 landscape", pdf_table_style=[ PdfTableStyle( @@ -801,6 +803,7 @@ with gooddata_api_client.ApiClient() as api_client: pdf_top_left_content="Good", pdf_top_right_content="Morning", show_filters=False, + show_info_page=False, ), visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", visualization_object_custom_filters=[ 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 a867a8738..5c1bd7084 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -67,6 +67,7 @@ from gooddata_api_client.model.locale_request import LocaleRequest from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner from gooddata_api_client.model.notifications import Notifications +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment from gooddata_api_client.model.platform_usage import PlatformUsage from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest @@ -90,9 +91,11 @@ from gooddata_api_client.model.test_request import TestRequest from gooddata_api_client.model.test_response import TestResponse from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse from gooddata_api_client.model.visual_export_request import VisualExportRequest +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups from gooddata_api_client.model.workspace_users import WorkspaceUsers @@ -1456,6 +1459,7 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'visual_export_request', + 'x_gdc_debug', ], 'required': [ 'workspace_id', @@ -1478,13 +1482,17 @@ def __init__(self, api_client=None): (str,), 'visual_export_request': (VisualExportRequest,), + 'x_gdc_debug': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'x_gdc_debug': 'X-Gdc-Debug', }, 'location_map': { 'workspace_id': 'path', 'visual_export_request': 'body', + 'x_gdc_debug': 'header', }, 'collection_format_map': { } @@ -1568,6 +1576,7 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'slides_export_request', + 'x_gdc_debug', ], 'required': [ 'workspace_id', @@ -1590,13 +1599,17 @@ def __init__(self, api_client=None): (str,), 'slides_export_request': (SlidesExportRequest,), + 'x_gdc_debug': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'x_gdc_debug': 'X-Gdc-Debug', }, 'location_map': { 'workspace_id': 'path', 'slides_export_request': 'body', + 'x_gdc_debug': 'header', }, 'collection_format_map': { } @@ -1722,6 +1735,108 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_organization_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/automations/delete', + 'operation_id': 'delete_organization_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'organization_automation_management_bulk_request', + ], + 'required': [ + 'organization_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'organization_automation_management_bulk_request': + (OrganizationAutomationManagementBulkRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'organization_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/delete', + 'operation_id': 'delete_workspace_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'required': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'workspace_automation_management_bulk_request': + (WorkspaceAutomationManagementBulkRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'workspace_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.explain_afm_endpoint = _Endpoint( settings={ 'response_type': None, @@ -2173,7 +2288,7 @@ def __init__(self, api_client=None): ) self.get_exported_file_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}', 'operation_id': 'get_exported_file', @@ -2228,7 +2343,7 @@ def __init__(self, api_client=None): ) self.get_image_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}', 'operation_id': 'get_image_export', @@ -2479,7 +2594,7 @@ def __init__(self, api_client=None): ) self.get_raw_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}', 'operation_id': 'get_raw_export', @@ -2536,7 +2651,7 @@ def __init__(self, api_client=None): ) self.get_slides_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}', 'operation_id': 'get_slides_export', @@ -2647,7 +2762,7 @@ def __init__(self, api_client=None): ) self.get_tabular_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}', 'operation_id': 'get_tabular_export', @@ -3612,6 +3727,108 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.pause_organization_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/automations/pause', + 'operation_id': 'pause_organization_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'organization_automation_management_bulk_request', + ], + 'required': [ + 'organization_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'organization_automation_management_bulk_request': + (OrganizationAutomationManagementBulkRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'organization_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.pause_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/pause', + 'operation_id': 'pause_workspace_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'required': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'workspace_automation_management_bulk_request': + (WorkspaceAutomationManagementBulkRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'workspace_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.register_upload_notification_endpoint = _Endpoint( settings={ 'response_type': None, @@ -4655,19 +4872,22 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.unsubscribe_all_automations_endpoint = _Endpoint( + self.unpause_organization_automations_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/unsubscribe', - 'operation_id': 'unsubscribe_all_automations', - 'http_method': 'DELETE', + 'endpoint_path': '/api/v1/actions/organization/automations/unpause', + 'operation_id': 'unpause_organization_automations', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ + 'organization_automation_management_bulk_request', + ], + 'required': [ + 'organization_automation_management_bulk_request', ], - 'required': [], 'nullable': [ ], 'enum': [ @@ -4681,37 +4901,42 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { + 'organization_automation_management_bulk_request': + (OrganizationAutomationManagementBulkRequest,), }, 'attribute_map': { }, 'location_map': { + 'organization_automation_management_bulk_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [], - 'content_type': [], + 'content_type': [ + 'application/json' + ] }, api_client=api_client ) - self.unsubscribe_automation_endpoint = _Endpoint( + self.unpause_workspace_automations_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe', - 'operation_id': 'unsubscribe_automation', - 'http_method': 'DELETE', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unpause', + 'operation_id': 'unpause_workspace_automations', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'automation_id', + 'workspace_automation_management_bulk_request', ], 'required': [ 'workspace_id', - 'automation_id', + 'workspace_automation_management_bulk_request', ], 'nullable': [ ], @@ -4728,42 +4953,40 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'automation_id': - (str,), + 'workspace_automation_management_bulk_request': + (WorkspaceAutomationManagementBulkRequest,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'automation_id': 'automationId', }, 'location_map': { 'workspace_id': 'path', - 'automation_id': 'path', + 'workspace_automation_management_bulk_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [], - 'content_type': [], + 'content_type': [ + 'application/json' + ] }, api_client=api_client ) - self.unsubscribe_workspace_automations_endpoint = _Endpoint( + self.unsubscribe_all_automations_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', - 'operation_id': 'unsubscribe_workspace_automations', + 'endpoint_path': '/api/v1/actions/organization/automations/unsubscribe', + 'operation_id': 'unsubscribe_all_automations', 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', ], + 'required': [], 'nullable': [ ], 'enum': [ @@ -4777,14 +5000,10 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'workspace_id': - (str,), }, 'attribute_map': { - 'workspace_id': 'workspaceId', }, 'location_map': { - 'workspace_id': 'path', }, 'collection_format_map': { } @@ -4795,21 +5014,23 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.validate_llm_endpoint_endpoint = _Endpoint( + self.unsubscribe_automation_endpoint = _Endpoint( settings={ - 'response_type': (ValidateLLMEndpointResponse,), + 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/ai/validateLlmEndpoint', - 'operation_id': 'validate_llm_endpoint', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe', + 'operation_id': 'unsubscribe_automation', + 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ - 'validate_llm_endpoint_request', + 'workspace_id', + 'automation_id', ], 'required': [ - 'validate_llm_endpoint_request', + 'workspace_id', + 'automation_id', ], 'nullable': [ ], @@ -4824,28 +5045,235 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'validate_llm_endpoint_request': - (ValidateLLMEndpointRequest,), + 'workspace_id': + (str,), + 'automation_id': + (str,), }, 'attribute_map': { + 'workspace_id': 'workspaceId', + 'automation_id': 'automationId', }, 'location_map': { - 'validate_llm_endpoint_request': 'body', + 'workspace_id': 'path', + 'automation_id': 'path', }, 'collection_format_map': { } }, headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) - self.workspace_resolve_all_settings_endpoint = _Endpoint( + self.unsubscribe_selected_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', + 'operation_id': 'unsubscribe_selected_workspace_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'required': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'workspace_automation_management_bulk_request': + (WorkspaceAutomationManagementBulkRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'workspace_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.unsubscribe_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', + 'operation_id': 'unsubscribe_workspace_automations', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.validate_llm_endpoint_endpoint = _Endpoint( + settings={ + 'response_type': (ValidateLLMEndpointResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmEndpoint/test', + 'operation_id': 'validate_llm_endpoint', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'validate_llm_endpoint_request', + ], + 'required': [ + 'validate_llm_endpoint_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'validate_llm_endpoint_request': + (ValidateLLMEndpointRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'validate_llm_endpoint_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.validate_llm_endpoint_by_id_endpoint = _Endpoint( + settings={ + 'response_type': (ValidateLLMEndpointResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test', + 'operation_id': 'validate_llm_endpoint_by_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'llm_endpoint_id', + 'validate_llm_endpoint_by_id_request', + ], + 'required': [ + 'llm_endpoint_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'llm_endpoint_id': + (str,), + 'validate_llm_endpoint_by_id_request': + (ValidateLLMEndpointByIdRequest,), + }, + 'attribute_map': { + 'llm_endpoint_id': 'llmEndpointId', + }, + 'location_map': { + 'llm_endpoint_id': 'path', + 'validate_llm_endpoint_by_id_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.workspace_resolve_all_settings_endpoint = _Endpoint( settings={ 'response_type': ([ResolvedSetting],), 'auth': [], @@ -6807,6 +7235,7 @@ def create_pdf_export( visual_export_request (VisualExportRequest): Keyword Args: + x_gdc_debug (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -6981,6 +7410,7 @@ def create_slides_export( slides_export_request (SlidesExportRequest): Keyword Args: + x_gdc_debug (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -7221,27 +7651,23 @@ def dashboard_permissions( dashboard_id return self.dashboard_permissions_endpoint.call_with_http_info(**kwargs) - def explain_afm( + def delete_organization_automations( self, - workspace_id, - afm_execution, + organization_automation_management_bulk_request, **kwargs ): - """AFM explain resource. # noqa: E501 + """Delete selected automations across all workspaces # noqa: E501 - The resource provides static structures needed for investigation of a problem with given AFM. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.explain_afm(workspace_id, afm_execution, async_req=True) + >>> thread = api.delete_organization_automations(organization_automation_management_bulk_request, async_req=True) >>> result = thread.get() Args: - workspace_id (str): Workspace identifier - afm_execution (AfmExecution): + organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): Keyword Args: - explain_type (str): Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -7303,35 +7729,29 @@ def explain_afm( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['afm_execution'] = \ - afm_execution - return self.explain_afm_endpoint.call_with_http_info(**kwargs) + kwargs['organization_automation_management_bulk_request'] = \ + organization_automation_management_bulk_request + return self.delete_organization_automations_endpoint.call_with_http_info(**kwargs) - def forecast( + def delete_workspace_automations( self, workspace_id, - result_id, - forecast_request, + workspace_automation_management_bulk_request, **kwargs ): - """(BETA) Smart functions - Forecast # noqa: E501 + """Delete selected automations in the workspace # noqa: E501 - (BETA) Computes forecasted data points from the provided execution result and parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.forecast(workspace_id, result_id, forecast_request, async_req=True) + >>> thread = api.delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) >>> result = thread.get() Args: - workspace_id (str): Workspace identifier - result_id (str): Input result ID to be used in the computation - forecast_request (ForecastRequest): + workspace_id (str): + workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -7364,7 +7784,7 @@ def forecast( async_req (bool): execute request asynchronously Returns: - SmartFunctionResponse + None If the method is called asynchronously, returns the request thread. """ @@ -7395,34 +7815,31 @@ def forecast( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['result_id'] = \ - result_id - kwargs['forecast_request'] = \ - forecast_request - return self.forecast_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_automation_management_bulk_request'] = \ + workspace_automation_management_bulk_request + return self.delete_workspace_automations_endpoint.call_with_http_info(**kwargs) - def forecast_result( + def explain_afm( self, workspace_id, - result_id, + afm_execution, **kwargs ): - """(BETA) Smart functions - Forecast Result # noqa: E501 + """AFM explain resource. # noqa: E501 - (BETA) Gets forecast result. # noqa: E501 + The resource provides static structures needed for investigation of a problem with given AFM. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.forecast_result(workspace_id, result_id, async_req=True) + >>> thread = api.explain_afm(workspace_id, afm_execution, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - result_id (str): Result ID + afm_execution (AfmExecution): Keyword Args: - offset (int): [optional] - limit (int): [optional] + explain_type (str): Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -7455,7 +7872,7 @@ def forecast_result( async_req (bool): execute request asynchronously Returns: - ForecastResult + None If the method is called asynchronously, returns the request thread. """ @@ -7486,27 +7903,208 @@ def forecast_result( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['result_id'] = \ - result_id - return self.forecast_result_endpoint.call_with_http_info(**kwargs) + kwargs['afm_execution'] = \ + afm_execution + return self.explain_afm_endpoint.call_with_http_info(**kwargs) - def generate_logical_model( + def forecast( self, - data_source_id, - generate_ldm_request, + workspace_id, + result_id, + forecast_request, **kwargs ): - """Generate logical data model (LDM) from physical data model (PDM) # noqa: E501 + """(BETA) Smart functions - Forecast # noqa: E501 - Generate logical data model (LDM) from physical data model (PDM) stored in data source. # noqa: E501 + (BETA) Computes forecasted data points from the provided execution result and parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.generate_logical_model(data_source_id, generate_ldm_request, async_req=True) + >>> thread = api.forecast(workspace_id, result_id, forecast_request, async_req=True) >>> result = thread.get() Args: - data_source_id (str): + workspace_id (str): Workspace identifier + result_id (str): Input result ID to be used in the computation + forecast_request (ForecastRequest): + + Keyword Args: + skip_cache (bool): Ignore all caches during execution of current request.. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + SmartFunctionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['result_id'] = \ + result_id + kwargs['forecast_request'] = \ + forecast_request + return self.forecast_endpoint.call_with_http_info(**kwargs) + + def forecast_result( + self, + workspace_id, + result_id, + **kwargs + ): + """(BETA) Smart functions - Forecast Result # noqa: E501 + + (BETA) Gets forecast result. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.forecast_result(workspace_id, result_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + result_id (str): Result ID + + Keyword Args: + offset (int): [optional] + limit (int): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ForecastResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['result_id'] = \ + result_id + return self.forecast_result_endpoint.call_with_http_info(**kwargs) + + def generate_logical_model( + self, + data_source_id, + generate_ldm_request, + **kwargs + ): + """Generate logical data model (LDM) from physical data model (PDM) # noqa: E501 + + Generate logical data model (LDM) from physical data model (PDM) stored in data source. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_logical_model(data_source_id, generate_ldm_request, async_req=True) + >>> result = thread.get() + + Args: + data_source_id (str): generate_ldm_request (GenerateLdmRequest): Keyword Args: @@ -7882,7 +8480,7 @@ def get_exported_file( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ @@ -7969,7 +8567,7 @@ def get_image_export( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ @@ -8313,7 +8911,7 @@ def get_raw_export( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ @@ -8400,7 +8998,7 @@ def get_slides_export( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ @@ -8574,7 +9172,7 @@ def get_tabular_export( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ @@ -10041,22 +10639,21 @@ def particular_platform_usage( platform_usage_request return self.particular_platform_usage_endpoint.call_with_http_info(**kwargs) - def register_upload_notification( + def pause_organization_automations( self, - data_source_id, + organization_automation_management_bulk_request, **kwargs ): - """Register an upload notification # noqa: E501 + """Pause selected automations across all workspaces # noqa: E501 - Notification sets up all reports to be computed again with new data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.register_upload_notification(data_source_id, async_req=True) + >>> thread = api.pause_organization_automations(organization_automation_management_bulk_request, async_req=True) >>> result = thread.get() Args: - data_source_id (str): + organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -10120,23 +10717,27 @@ def register_upload_notification( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['data_source_id'] = \ - data_source_id - return self.register_upload_notification_endpoint.call_with_http_info(**kwargs) + kwargs['organization_automation_management_bulk_request'] = \ + organization_automation_management_bulk_request + return self.pause_organization_automations_endpoint.call_with_http_info(**kwargs) - def resolve_all_entitlements( + def pause_workspace_automations( self, + workspace_id, + workspace_automation_management_bulk_request, **kwargs ): - """Values for all public entitlements. # noqa: E501 + """Pause selected automations in the workspace # noqa: E501 - Resolves values of available entitlements for the organization. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.resolve_all_entitlements(async_req=True) + >>> thread = api.pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): + workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -10171,7 +10772,7 @@ def resolve_all_entitlements( async_req (bool): execute request asynchronously Returns: - [ApiEntitlement] + None If the method is called asynchronously, returns the request thread. """ @@ -10200,21 +10801,28 @@ def resolve_all_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.resolve_all_entitlements_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['workspace_automation_management_bulk_request'] = \ + workspace_automation_management_bulk_request + return self.pause_workspace_automations_endpoint.call_with_http_info(**kwargs) - def resolve_all_settings_without_workspace( + def register_upload_notification( self, + data_source_id, **kwargs ): - """Values for all settings without workspace. # noqa: E501 + """Register an upload notification # noqa: E501 - Resolves values for all settings without workspace by current user, organization, or default settings. # noqa: E501 + Notification sets up all reports to be computed again with new data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.resolve_all_settings_without_workspace(async_req=True) + >>> thread = api.register_upload_notification(data_source_id, async_req=True) >>> result = thread.get() + Args: + data_source_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -10249,7 +10857,7 @@ def resolve_all_settings_without_workspace( async_req (bool): execute request asynchronously Returns: - [ResolvedSetting] + None If the method is called asynchronously, returns the request thread. """ @@ -10278,24 +10886,23 @@ def resolve_all_settings_without_workspace( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.resolve_all_settings_without_workspace_endpoint.call_with_http_info(**kwargs) + kwargs['data_source_id'] = \ + data_source_id + return self.register_upload_notification_endpoint.call_with_http_info(**kwargs) - def resolve_llm_endpoints( + def resolve_all_entitlements( self, - workspace_id, **kwargs ): - """Get Active LLM Endpoints for this workspace # noqa: E501 + """Values for all public entitlements. # noqa: E501 - Returns a list of available LLM Endpoints # noqa: E501 + Resolves values of available entitlements for the organization. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.resolve_llm_endpoints(workspace_id, async_req=True) + >>> thread = api.resolve_all_entitlements(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Workspace identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -10330,7 +10937,7 @@ def resolve_llm_endpoints( async_req (bool): execute request asynchronously Returns: - ResolvedLlmEndpoints + [ApiEntitlement] If the method is called asynchronously, returns the request thread. """ @@ -10359,26 +10966,21 @@ def resolve_llm_endpoints( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.resolve_llm_endpoints_endpoint.call_with_http_info(**kwargs) + return self.resolve_all_entitlements_endpoint.call_with_http_info(**kwargs) - def resolve_requested_entitlements( + def resolve_all_settings_without_workspace( self, - entitlements_request, **kwargs ): - """Values for requested public entitlements. # noqa: E501 + """Values for all settings without workspace. # noqa: E501 - Resolves values for requested entitlements in the organization. # noqa: E501 + Resolves values for all settings without workspace by current user, organization, or default settings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.resolve_requested_entitlements(entitlements_request, async_req=True) + >>> thread = api.resolve_all_settings_without_workspace(async_req=True) >>> result = thread.get() - Args: - entitlements_request (EntitlementsRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -10413,7 +11015,7 @@ def resolve_requested_entitlements( async_req (bool): execute request asynchronously Returns: - [ApiEntitlement] + [ResolvedSetting] If the method is called asynchronously, returns the request thread. """ @@ -10442,8 +11044,172 @@ def resolve_requested_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['entitlements_request'] = \ - entitlements_request + return self.resolve_all_settings_without_workspace_endpoint.call_with_http_info(**kwargs) + + def resolve_llm_endpoints( + self, + workspace_id, + **kwargs + ): + """Get Active LLM Endpoints for this workspace # noqa: E501 + + Returns a list of available LLM Endpoints # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.resolve_llm_endpoints(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ResolvedLlmEndpoints + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.resolve_llm_endpoints_endpoint.call_with_http_info(**kwargs) + + def resolve_requested_entitlements( + self, + entitlements_request, + **kwargs + ): + """Values for requested public entitlements. # noqa: E501 + + Resolves values for requested entitlements in the organization. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.resolve_requested_entitlements(entitlements_request, async_req=True) + >>> result = thread.get() + + Args: + entitlements_request (EntitlementsRequest): + + 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: + [ApiEntitlement] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['entitlements_request'] = \ + entitlements_request return self.resolve_requested_entitlements_endpoint.call_with_http_info(**kwargs) def resolve_settings_without_workspace( @@ -11649,6 +12415,174 @@ def trigger_existing_automation( automation_id return self.trigger_existing_automation_endpoint.call_with_http_info(**kwargs) + def unpause_organization_automations( + self, + organization_automation_management_bulk_request, + **kwargs + ): + """Unpause selected automations across all workspaces # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.unpause_organization_automations(organization_automation_management_bulk_request, async_req=True) + >>> result = thread.get() + + Args: + organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): + + 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['organization_automation_management_bulk_request'] = \ + organization_automation_management_bulk_request + return self.unpause_organization_automations_endpoint.call_with_http_info(**kwargs) + + def unpause_workspace_automations( + self, + workspace_id, + workspace_automation_management_bulk_request, + **kwargs + ): + """Unpause selected automations in 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.unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['workspace_automation_management_bulk_request'] = \ + workspace_automation_management_bulk_request + return self.unpause_workspace_automations_endpoint.call_with_http_info(**kwargs) + def unsubscribe_all_automations( self, **kwargs @@ -11812,6 +12746,92 @@ def unsubscribe_automation( automation_id return self.unsubscribe_automation_endpoint.call_with_http_info(**kwargs) + def unsubscribe_selected_workspace_automations( + self, + workspace_id, + workspace_automation_management_bulk_request, + **kwargs + ): + """Unsubscribe from selected automations in 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.unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['workspace_automation_management_bulk_request'] = \ + workspace_automation_management_bulk_request + return self.unsubscribe_selected_workspace_automations_endpoint.call_with_http_info(**kwargs) + def unsubscribe_workspace_automations( self, workspace_id, @@ -11977,6 +12997,90 @@ def validate_llm_endpoint( validate_llm_endpoint_request return self.validate_llm_endpoint_endpoint.call_with_http_info(**kwargs) + def validate_llm_endpoint_by_id( + self, + llm_endpoint_id, + **kwargs + ): + """Validate LLM Endpoint By Id # noqa: E501 + + Validates existing LLM endpoint with provided parameters and updates it if they are valid. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_llm_endpoint_by_id(llm_endpoint_id, async_req=True) + >>> result = thread.get() + + Args: + llm_endpoint_id (str): + + Keyword Args: + validate_llm_endpoint_by_id_request (ValidateLLMEndpointByIdRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ValidateLLMEndpointResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['llm_endpoint_id'] = \ + llm_endpoint_id + return self.validate_llm_endpoint_by_id_endpoint.call_with_http_info(**kwargs) + def workspace_resolve_all_settings( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/automation_organization_view_controller_api.py b/gooddata-api-client/gooddata_api_client/api/automation_organization_view_controller_api.py new file mode 100644 index 000000000..38441186f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/automation_organization_view_controller_api.py @@ -0,0 +1,224 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList + + +class AutomationOrganizationViewControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_automations_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceAutomationOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/organization/workspaceAutomations', + 'operation_id': 'get_all_automations_workspace_automations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERIDENTIFIERS": "userIdentifiers", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_all_automations_workspace_automations( + self, + **kwargs + ): + """Get all Automations across all Workspaces # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_automations_workspace_automations(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceAutomationOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/automations_api.py b/gooddata-api-client/gooddata_api_client/api/automations_api.py index 7534ab2e8..4d1edc674 100644 --- a/gooddata-api-client/gooddata_api_client/api/automations_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automations_api.py @@ -27,7 +27,10 @@ from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest class AutomationsApi(object): @@ -91,7 +94,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -195,6 +197,210 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_organization_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/automations/delete', + 'operation_id': 'delete_organization_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'organization_automation_management_bulk_request', + ], + 'required': [ + 'organization_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'organization_automation_management_bulk_request': + (OrganizationAutomationManagementBulkRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'organization_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/delete', + 'operation_id': 'delete_workspace_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'required': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'workspace_automation_management_bulk_request': + (WorkspaceAutomationManagementBulkRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'workspace_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_all_automations_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceAutomationOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/organization/workspaceAutomations', + 'operation_id': 'get_all_automations_workspace_automations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERIDENTIFIERS": "userIdentifiers", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_automations_endpoint = _Endpoint( settings={ 'response_type': (JsonApiAutomationOutList,), @@ -256,7 +462,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -435,7 +640,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -535,7 +739,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, }, @@ -578,23 +781,21 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.set_automations_endpoint = _Endpoint( + self.pause_organization_automations_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/automations', - 'operation_id': 'set_automations', - 'http_method': 'PUT', + 'endpoint_path': '/api/v1/actions/organization/automations/pause', + 'operation_id': 'pause_organization_automations', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'declarative_automation', + 'organization_automation_management_bulk_request', ], 'required': [ - 'workspace_id', - 'declarative_automation', + 'organization_automation_management_bulk_request', ], 'nullable': [ ], @@ -609,17 +810,13 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'workspace_id': - (str,), - 'declarative_automation': - ([DeclarativeAutomation],), + 'organization_automation_management_bulk_request': + (OrganizationAutomationManagementBulkRequest,), }, 'attribute_map': { - 'workspace_id': 'workspaceId', }, 'location_map': { - 'workspace_id': 'path', - 'declarative_automation': 'body', + 'organization_automation_management_bulk_request': 'body', }, 'collection_format_map': { } @@ -632,23 +829,23 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.trigger_automation_endpoint = _Endpoint( + self.pause_workspace_automations_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/trigger', - 'operation_id': 'trigger_automation', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/pause', + 'operation_id': 'pause_workspace_automations', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'trigger_automation_request', + 'workspace_automation_management_bulk_request', ], 'required': [ 'workspace_id', - 'trigger_automation_request', + 'workspace_automation_management_bulk_request', ], 'nullable': [ ], @@ -665,15 +862,15 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'trigger_automation_request': - (TriggerAutomationRequest,), + 'workspace_automation_management_bulk_request': + (WorkspaceAutomationManagementBulkRequest,), }, 'attribute_map': { 'workspace_id': 'workspaceId', }, 'location_map': { 'workspace_id': 'path', - 'trigger_automation_request': 'body', + 'workspace_automation_management_bulk_request': 'body', }, 'collection_format_map': { } @@ -686,23 +883,23 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.trigger_existing_automation_endpoint = _Endpoint( + self.set_automations_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger', - 'operation_id': 'trigger_existing_automation', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/automations', + 'operation_id': 'set_automations', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'automation_id', + 'declarative_automation', ], 'required': [ 'workspace_id', - 'automation_id', + 'declarative_automation', ], 'nullable': [ ], @@ -719,39 +916,45 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'automation_id': - (str,), + 'declarative_automation': + ([DeclarativeAutomation],), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'automation_id': 'automationId', }, 'location_map': { 'workspace_id': 'path', - 'automation_id': 'path', + 'declarative_automation': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [], - 'content_type': [], + 'content_type': [ + 'application/json' + ] }, api_client=api_client ) - self.unsubscribe_all_automations_endpoint = _Endpoint( + self.trigger_automation_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/automations/unsubscribe', - 'operation_id': 'unsubscribe_all_automations', - 'http_method': 'DELETE', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/trigger', + 'operation_id': 'trigger_automation', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ + 'workspace_id', + 'trigger_automation_request', + ], + 'required': [ + 'workspace_id', + 'trigger_automation_request', ], - 'required': [], 'nullable': [ ], 'enum': [ @@ -765,19 +968,223 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { + 'workspace_id': + (str,), + 'trigger_automation_request': + (TriggerAutomationRequest,), }, 'attribute_map': { + 'workspace_id': 'workspaceId', }, 'location_map': { + 'workspace_id': 'path', + 'trigger_automation_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [], - 'content_type': [], - }, - api_client=api_client + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.trigger_existing_automation_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger', + 'operation_id': 'trigger_existing_automation', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'automation_id', + ], + 'required': [ + 'workspace_id', + 'automation_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'automation_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'automation_id': 'automationId', + }, + 'location_map': { + 'workspace_id': 'path', + 'automation_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.unpause_organization_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/automations/unpause', + 'operation_id': 'unpause_organization_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'organization_automation_management_bulk_request', + ], + 'required': [ + 'organization_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'organization_automation_management_bulk_request': + (OrganizationAutomationManagementBulkRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'organization_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.unpause_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unpause', + 'operation_id': 'unpause_workspace_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'required': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'workspace_automation_management_bulk_request': + (WorkspaceAutomationManagementBulkRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'workspace_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.unsubscribe_all_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/automations/unsubscribe', + 'operation_id': 'unsubscribe_all_automations', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client ) self.unsubscribe_automation_endpoint = _Endpoint( settings={ @@ -832,6 +1239,60 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.unsubscribe_selected_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe', + 'operation_id': 'unsubscribe_selected_workspace_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'required': [ + 'workspace_id', + 'workspace_automation_management_bulk_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'workspace_automation_management_bulk_request': + (WorkspaceAutomationManagementBulkRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'workspace_automation_management_bulk_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.unsubscribe_workspace_automations_endpoint = _Endpoint( settings={ 'response_type': None, @@ -926,7 +1387,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, }, @@ -970,26 +1430,628 @@ def __init__(self, api_client=None): api_client=api_client ) - def create_entity_automations( + def create_entity_automations( + self, + workspace_id, + json_api_automation_in_document, + **kwargs + ): + """Post Automations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_automations(workspace_id, json_api_automation_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_automation_in_document (JsonApiAutomationInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAutomationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_automation_in_document'] = \ + json_api_automation_in_document + return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) + + def delete_entity_automations( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete an Automation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) + + def delete_organization_automations( + self, + organization_automation_management_bulk_request, + **kwargs + ): + """Delete selected automations across all workspaces # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_organization_automations(organization_automation_management_bulk_request, async_req=True) + >>> result = thread.get() + + Args: + organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): + + 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['organization_automation_management_bulk_request'] = \ + organization_automation_management_bulk_request + return self.delete_organization_automations_endpoint.call_with_http_info(**kwargs) + + def delete_workspace_automations( + self, + workspace_id, + workspace_automation_management_bulk_request, + **kwargs + ): + """Delete selected automations in the workspace # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['workspace_automation_management_bulk_request'] = \ + workspace_automation_management_bulk_request + return self.delete_workspace_automations_endpoint.call_with_http_info(**kwargs) + + def get_all_automations_workspace_automations( + self, + **kwargs + ): + """Get all Automations across all Workspaces # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_automations_workspace_automations(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceAutomationOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_automations( + self, + workspace_id, + **kwargs + ): + """Get all Automations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_automations(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: + JsonApiAutomationOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) + + def get_automations( + self, + workspace_id, + **kwargs + ): + """Get automations # noqa: E501 + + Retrieve automations for the specific 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_automations(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + exclude ([str]): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [DeclarativeAutomation] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_automations_endpoint.call_with_http_info(**kwargs) + + def get_entity_automations( self, workspace_id, - json_api_automation_in_document, + object_id, **kwargs ): - """Post Automations # noqa: E501 + """Get an Automation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_automations(workspace_id, json_api_automation_in_document, async_req=True) + >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): + object_id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1054,30 +2116,33 @@ def create_entity_automations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) - def delete_entity_automations( + def patch_entity_automations( self, workspace_id, object_id, + json_api_automation_patch_document, **kwargs ): - """Delete an Automation # noqa: E501 + """Patch an Automation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) + >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): + json_api_automation_patch_document (JsonApiAutomationPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1110,7 +2175,7 @@ def delete_entity_automations( async_req (bool): execute request asynchronously Returns: - None + JsonApiAutomationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1143,33 +2208,27 @@ def delete_entity_automations( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_automation_patch_document'] = \ + json_api_automation_patch_document + return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) - def get_all_entities_automations( + def pause_organization_automations( self, - workspace_id, + organization_automation_management_bulk_request, **kwargs ): - """Get all Automations # noqa: E501 + """Pause selected automations across all workspaces # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) + >>> thread = api.pause_organization_automations(organization_automation_management_bulk_request, async_req=True) >>> result = thread.get() Args: - workspace_id (str): + organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): 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 @@ -1202,7 +2261,7 @@ def get_all_entities_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutList + None If the method is called asynchronously, returns the request thread. """ @@ -1231,29 +2290,29 @@ def get_all_entities_automations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) + kwargs['organization_automation_management_bulk_request'] = \ + organization_automation_management_bulk_request + return self.pause_organization_automations_endpoint.call_with_http_info(**kwargs) - def get_automations( + def pause_workspace_automations( self, workspace_id, + workspace_automation_management_bulk_request, **kwargs ): - """Get automations # noqa: E501 + """Pause selected automations in the workspace # noqa: E501 - Retrieve automations for the specific 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_automations(workspace_id, async_req=True) + >>> thread = api.pause_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): + workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): Keyword Args: - exclude ([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 @@ -1286,7 +2345,7 @@ def get_automations( async_req (bool): execute request asynchronously Returns: - [DeclarativeAutomation] + None If the method is called asynchronously, returns the request thread. """ @@ -1317,31 +2376,30 @@ def get_automations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_automations_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_automation_management_bulk_request'] = \ + workspace_automation_management_bulk_request + return self.pause_workspace_automations_endpoint.call_with_http_info(**kwargs) - def get_entity_automations( + def set_automations( self, workspace_id, - object_id, + declarative_automation, **kwargs ): - """Get an Automation # noqa: E501 + """Set automations # noqa: E501 + Set automations for the specific workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) + >>> thread = api.set_automations(workspace_id, declarative_automation, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): + declarative_automation ([DeclarativeAutomation]): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1374,7 +2432,7 @@ def get_entity_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -1405,33 +2463,30 @@ def get_entity_automations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['declarative_automation'] = \ + declarative_automation + return self.set_automations_endpoint.call_with_http_info(**kwargs) - def patch_entity_automations( + def trigger_automation( self, workspace_id, - object_id, - json_api_automation_patch_document, + trigger_automation_request, **kwargs ): - """Patch an Automation # noqa: E501 + """Trigger automation. # noqa: E501 + Trigger the automation in the request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) + >>> thread = api.trigger_automation(workspace_id, trigger_automation_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_automation_patch_document (JsonApiAutomationPatchDocument): + trigger_automation_request (TriggerAutomationRequest): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1464,7 +2519,7 @@ def patch_entity_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -1495,30 +2550,28 @@ def patch_entity_automations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_patch_document'] = \ - json_api_automation_patch_document - return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['trigger_automation_request'] = \ + trigger_automation_request + return self.trigger_automation_endpoint.call_with_http_info(**kwargs) - def set_automations( + def trigger_existing_automation( self, workspace_id, - declarative_automation, + automation_id, **kwargs ): - """Set automations # noqa: E501 + """Trigger existing automation. # noqa: E501 - Set automations for the specific workspace. # noqa: E501 + Trigger the existing automation to execute immediately. # 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_automations(workspace_id, declarative_automation, async_req=True) + >>> thread = api.trigger_existing_automation(workspace_id, automation_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - declarative_automation ([DeclarativeAutomation]): + automation_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -1584,28 +2637,25 @@ def set_automations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['declarative_automation'] = \ - declarative_automation - return self.set_automations_endpoint.call_with_http_info(**kwargs) + kwargs['automation_id'] = \ + automation_id + return self.trigger_existing_automation_endpoint.call_with_http_info(**kwargs) - def trigger_automation( + def unpause_organization_automations( self, - workspace_id, - trigger_automation_request, + organization_automation_management_bulk_request, **kwargs ): - """Trigger automation. # noqa: E501 + """Unpause selected automations across all workspaces # noqa: E501 - Trigger the automation in the request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.trigger_automation(workspace_id, trigger_automation_request, async_req=True) + >>> thread = api.unpause_organization_automations(organization_automation_management_bulk_request, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - trigger_automation_request (TriggerAutomationRequest): + organization_automation_management_bulk_request (OrganizationAutomationManagementBulkRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -1669,30 +2719,27 @@ def trigger_automation( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['trigger_automation_request'] = \ - trigger_automation_request - return self.trigger_automation_endpoint.call_with_http_info(**kwargs) + kwargs['organization_automation_management_bulk_request'] = \ + organization_automation_management_bulk_request + return self.unpause_organization_automations_endpoint.call_with_http_info(**kwargs) - def trigger_existing_automation( + def unpause_workspace_automations( self, workspace_id, - automation_id, + workspace_automation_management_bulk_request, **kwargs ): - """Trigger existing automation. # noqa: E501 + """Unpause selected automations in the workspace # noqa: E501 - Trigger the existing automation to execute immediately. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.trigger_existing_automation(workspace_id, automation_id, async_req=True) + >>> thread = api.unpause_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): - automation_id (str): + workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -1758,9 +2805,9 @@ def trigger_existing_automation( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['automation_id'] = \ - automation_id - return self.trigger_existing_automation_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_automation_management_bulk_request'] = \ + workspace_automation_management_bulk_request + return self.unpause_workspace_automations_endpoint.call_with_http_info(**kwargs) def unsubscribe_all_automations( self, @@ -1925,6 +2972,92 @@ def unsubscribe_automation( automation_id return self.unsubscribe_automation_endpoint.call_with_http_info(**kwargs) + def unsubscribe_selected_workspace_automations( + self, + workspace_id, + workspace_automation_management_bulk_request, + **kwargs + ): + """Unsubscribe from selected automations in 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.unsubscribe_selected_workspace_automations(workspace_id, workspace_automation_management_bulk_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + workspace_automation_management_bulk_request (WorkspaceAutomationManagementBulkRequest): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['workspace_automation_management_bulk_request'] = \ + workspace_automation_management_bulk_request + return self.unsubscribe_selected_workspace_automations_endpoint.call_with_http_info(**kwargs) + def unsubscribe_workspace_automations( self, workspace_id, 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 373b56d2b..d63c32037 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -154,6 +154,7 @@ from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList @@ -474,7 +475,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -3943,6 +3943,108 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_automations_workspace_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceAutomationOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/organization/workspaceAutomations', + 'operation_id': 'get_all_automations_workspace_automations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERIDENTIFIERS": "userIdentifiers", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_aggregated_facts_endpoint = _Endpoint( settings={ 'response_type': (JsonApiAggregatedFactOutList,), @@ -4580,7 +4682,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -8397,7 +8498,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -11396,7 +11496,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, }, @@ -13615,7 +13714,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, }, @@ -20647,6 +20745,89 @@ def delete_entity_workspaces( id return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) + def get_all_automations_workspace_automations( + self, + **kwargs + ): + """Get all Automations across all Workspaces # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_automations_workspace_automations(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceAutomationOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) + def get_all_entities_aggregated_facts( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/image_export_api.py b/gooddata-api-client/gooddata_api_client/api/image_export_api.py index 3621d5840..bf670ba89 100644 --- a/gooddata-api-client/gooddata_api_client/api/image_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/image_export_api.py @@ -96,7 +96,7 @@ def __init__(self, api_client=None): ) self.get_image_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}', 'operation_id': 'get_image_export', @@ -344,7 +344,7 @@ def get_image_export( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ diff --git a/gooddata-api-client/gooddata_api_client/api/raw_export_api.py b/gooddata-api-client/gooddata_api_client/api/raw_export_api.py index 215c69600..7066a0f4d 100644 --- a/gooddata-api-client/gooddata_api_client/api/raw_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/raw_export_api.py @@ -95,7 +95,7 @@ def __init__(self, api_client=None): ) self.get_raw_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}', 'operation_id': 'get_raw_export', @@ -290,7 +290,7 @@ def get_raw_export( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ diff --git a/gooddata-api-client/gooddata_api_client/api/slides_export_api.py b/gooddata-api-client/gooddata_api_client/api/slides_export_api.py index e789983fc..3cc37b6a5 100644 --- a/gooddata-api-client/gooddata_api_client/api/slides_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/slides_export_api.py @@ -51,6 +51,7 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'slides_export_request', + 'x_gdc_debug', ], 'required': [ 'workspace_id', @@ -73,13 +74,17 @@ def __init__(self, api_client=None): (str,), 'slides_export_request': (SlidesExportRequest,), + 'x_gdc_debug': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'x_gdc_debug': 'X-Gdc-Debug', }, 'location_map': { 'workspace_id': 'path', 'slides_export_request': 'body', + 'x_gdc_debug': 'header', }, 'collection_format_map': { } @@ -96,7 +101,7 @@ def __init__(self, api_client=None): ) self.get_slides_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}', 'operation_id': 'get_slides_export', @@ -226,6 +231,7 @@ def create_slides_export( slides_export_request (SlidesExportRequest): Keyword Args: + x_gdc_debug (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -345,7 +351,7 @@ def get_slides_export( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ diff --git a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py index 7d2ccdf22..372c35147 100644 --- a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py @@ -37,6 +37,7 @@ from gooddata_api_client.model.search_request import SearchRequest from gooddata_api_client.model.search_result import SearchResult from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse @@ -858,7 +859,7 @@ def __init__(self, api_client=None): settings={ 'response_type': (ValidateLLMEndpointResponse,), 'auth': [], - 'endpoint_path': '/api/v1/actions/ai/validateLlmEndpoint', + 'endpoint_path': '/api/v1/actions/ai/llmEndpoint/test', 'operation_id': 'validate_llm_endpoint', 'http_method': 'POST', 'servers': None, @@ -904,6 +905,61 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.validate_llm_endpoint_by_id_endpoint = _Endpoint( + settings={ + 'response_type': (ValidateLLMEndpointResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test', + 'operation_id': 'validate_llm_endpoint_by_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'llm_endpoint_id', + 'validate_llm_endpoint_by_id_request', + ], + 'required': [ + 'llm_endpoint_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'llm_endpoint_id': + (str,), + 'validate_llm_endpoint_by_id_request': + (ValidateLLMEndpointByIdRequest,), + }, + 'attribute_map': { + 'llm_endpoint_id': 'llmEndpointId', + }, + 'location_map': { + 'llm_endpoint_id': 'path', + 'validate_llm_endpoint_by_id_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) def ai_chat( self, @@ -2045,3 +2101,87 @@ def validate_llm_endpoint( validate_llm_endpoint_request return self.validate_llm_endpoint_endpoint.call_with_http_info(**kwargs) + def validate_llm_endpoint_by_id( + self, + llm_endpoint_id, + **kwargs + ): + """Validate LLM Endpoint By Id # noqa: E501 + + Validates existing LLM endpoint with provided parameters and updates it if they are valid. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_llm_endpoint_by_id(llm_endpoint_id, async_req=True) + >>> result = thread.get() + + Args: + llm_endpoint_id (str): + + Keyword Args: + validate_llm_endpoint_by_id_request (ValidateLLMEndpointByIdRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ValidateLLMEndpointResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['llm_endpoint_id'] = \ + llm_endpoint_id + return self.validate_llm_endpoint_by_id_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/tabular_export_api.py b/gooddata-api-client/gooddata_api_client/api/tabular_export_api.py index 1c0097ad3..445bfaf4e 100644 --- a/gooddata-api-client/gooddata_api_client/api/tabular_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/tabular_export_api.py @@ -158,7 +158,7 @@ def __init__(self, api_client=None): ) self.get_tabular_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}', 'operation_id': 'get_tabular_export', @@ -445,7 +445,7 @@ def get_tabular_export( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ diff --git a/gooddata-api-client/gooddata_api_client/api/visual_export_api.py b/gooddata-api-client/gooddata_api_client/api/visual_export_api.py index 007962c1d..cbfdf040f 100644 --- a/gooddata-api-client/gooddata_api_client/api/visual_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/visual_export_api.py @@ -50,6 +50,7 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'visual_export_request', + 'x_gdc_debug', ], 'required': [ 'workspace_id', @@ -72,13 +73,17 @@ def __init__(self, api_client=None): (str,), 'visual_export_request': (VisualExportRequest,), + 'x_gdc_debug': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'x_gdc_debug': 'X-Gdc-Debug', }, 'location_map': { 'workspace_id': 'path', 'visual_export_request': 'body', + 'x_gdc_debug': 'header', }, 'collection_format_map': { } @@ -95,7 +100,7 @@ def __init__(self, api_client=None): ) self.get_exported_file_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}', 'operation_id': 'get_exported_file', @@ -224,6 +229,7 @@ def create_pdf_export( visual_export_request (VisualExportRequest): Keyword Args: + x_gdc_debug (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -343,7 +349,7 @@ def get_exported_file( async_req (bool): execute request asynchronously Returns: - None + file_type If the method is called asynchronously, returns the request thread. """ diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py index a8a61c65a..2ac5b9fd3 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py @@ -344,7 +344,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -2685,7 +2684,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -4860,7 +4858,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, ('meta_include',): { @@ -6451,7 +6448,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, }, @@ -7595,7 +7591,6 @@ def __init__(self, api_client=None): "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "RECIPIENTS": "recipients", - "AUTOMATIONRESULT": "automationResult", "ALL": "ALL" }, }, diff --git a/gooddata-api-client/gooddata_api_client/apis/__init__.py b/gooddata-api-client/gooddata_api_client/apis/__init__.py index 8e45b4a8d..2dc15f243 100644 --- a/gooddata-api-client/gooddata_api_client/apis/__init__.py +++ b/gooddata-api-client/gooddata_api_client/apis/__init__.py @@ -79,6 +79,7 @@ from gooddata_api_client.api.workspaces_entity_apis_api import WorkspacesEntityAPIsApi from gooddata_api_client.api.workspaces_settings_api import WorkspacesSettingsApi from gooddata_api_client.api.actions_api import ActionsApi +from gooddata_api_client.api.automation_organization_view_controller_api import AutomationOrganizationViewControllerApi from gooddata_api_client.api.entities_api import EntitiesApi from gooddata_api_client.api.layout_api import LayoutApi from gooddata_api_client.api.organization_controller_api import OrganizationControllerApi 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 1bcb54327..cc2a3f6a2 100644 --- a/gooddata-api-client/gooddata_api_client/model/api_entitlement.py +++ b/gooddata-api-client/gooddata_api_client/model/api_entitlement.py @@ -67,6 +67,7 @@ class ApiEntitlement(ModelNormal): 'UILOCALIZATION': "UiLocalization", 'TIER': "Tier", 'USERCOUNT': "UserCount", + 'MANAGEDIDPUSERCOUNT': "ManagedIdpUserCount", 'UNLIMITEDUSERS': "UnlimitedUsers", 'UNLIMITEDWORKSPACES': "UnlimitedWorkspaces", 'WHITELABELING': "WhiteLabeling", diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_format.py b/gooddata-api-client/gooddata_api_client/model/attribute_format.py index 6cdcbc713..013d9636e 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_format.py +++ b/gooddata-api-client/gooddata_api_client/model/attribute_format.py @@ -84,6 +84,7 @@ def openapi_types(): return { 'locale': (str,), # noqa: E501 'pattern': (str,), # noqa: E501 + 'timezone': (str,), # noqa: E501 } @cached_property @@ -94,6 +95,7 @@ def discriminator(): attribute_map = { 'locale': 'locale', # noqa: E501 'pattern': 'pattern', # noqa: E501 + 'timezone': 'timezone', # noqa: E501 } read_only_vars = { @@ -141,6 +143,7 @@ def _from_openapi_data(cls, locale, pattern, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + timezone (str): Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -232,6 +235,7 @@ def __init__(self, locale, pattern, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + timezone (str): Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) 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 f6b5e5d37..353069524 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py @@ -70,6 +70,7 @@ class DeclarativeSetting(ModelNormal): 'METADATA_LOCALE': "METADATA_LOCALE", 'FORMAT_LOCALE': "FORMAT_LOCALE", 'MAPBOX_TOKEN': "MAPBOX_TOKEN", + 'AG_GRID_TOKEN': "AG_GRID_TOKEN", 'WEEK_START': "WEEK_START", 'SHOW_HIDDEN_CATALOG_ITEMS': "SHOW_HIDDEN_CATALOG_ITEMS", 'OPERATOR_OVERRIDES': "OPERATOR_OVERRIDES", @@ -87,6 +88,7 @@ class DeclarativeSetting(ModelNormal): 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", 'ATTACHMENT_LINK_TTL': "ATTACHMENT_LINK_TTL", 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE': "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS': "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", }, } 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 97657e14c..66625f74f 100644 --- a/gooddata-api-client/gooddata_api_client/model/entitlements_request.py +++ b/gooddata-api-client/gooddata_api_client/model/entitlements_request.py @@ -67,6 +67,7 @@ class EntitlementsRequest(ModelNormal): 'UILOCALIZATION': "UiLocalization", 'TIER': "Tier", 'USERCOUNT': "UserCount", + 'MANAGEDIDPUSERCOUNT': "ManagedIdpUserCount", 'UNLIMITEDUSERS': "UnlimitedUsers", 'UNLIMITEDWORKSPACES': "UnlimitedWorkspaces", 'WHITELABELING': "WhiteLabeling", diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py index e41ad5710..3cb64f625 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py @@ -36,13 +36,13 @@ def lazy_import(): from gooddata_api_client.model.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions from gooddata_api_client.model.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel from gooddata_api_client.model.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients - from gooddata_api_client.model.json_api_automation_out_relationships_automation_result import JsonApiAutomationOutRelationshipsAutomationResult + from gooddata_api_client.model.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard globals()['JsonApiAutomationInRelationshipsExportDefinitions'] = JsonApiAutomationInRelationshipsExportDefinitions globals()['JsonApiAutomationInRelationshipsNotificationChannel'] = JsonApiAutomationInRelationshipsNotificationChannel globals()['JsonApiAutomationInRelationshipsRecipients'] = JsonApiAutomationInRelationshipsRecipients - globals()['JsonApiAutomationOutRelationshipsAutomationResult'] = JsonApiAutomationOutRelationshipsAutomationResult + globals()['JsonApiAutomationOutRelationshipsAutomationResults'] = JsonApiAutomationOutRelationshipsAutomationResults class JsonApiAutomationOutRelationships(ModelNormal): @@ -99,7 +99,7 @@ def openapi_types(): lazy_import() return { 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 - 'automation_result': (JsonApiAutomationOutRelationshipsAutomationResult,), # noqa: E501 + 'automation_results': (JsonApiAutomationOutRelationshipsAutomationResults,), # noqa: E501 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 'export_definitions': (JsonApiAutomationInRelationshipsExportDefinitions,), # noqa: E501 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 @@ -114,7 +114,7 @@ def discriminator(): attribute_map = { 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 - 'automation_result': 'automationResult', # noqa: E501 + 'automation_results': 'automationResults', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'export_definitions': 'exportDefinitions', # noqa: E501 'modified_by': 'modifiedBy', # noqa: E501 @@ -164,7 +164,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - automation_result (JsonApiAutomationOutRelationshipsAutomationResult): [optional] # noqa: E501 + automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 @@ -256,7 +256,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 - automation_result (JsonApiAutomationOutRelationshipsAutomationResult): [optional] # noqa: E501 + automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_result.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py similarity index 97% rename from gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_result.py rename to gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py index 80c2f0a10..347234afe 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_result.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py @@ -35,7 +35,7 @@ def lazy_import(): globals()['JsonApiAutomationResultToManyLinkage'] = JsonApiAutomationResultToManyLinkage -class JsonApiAutomationOutRelationshipsAutomationResult(ModelNormal): +class JsonApiAutomationOutRelationshipsAutomationResults(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -108,7 +108,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutRelationshipsAutomationResult - a model defined in OpenAPI + """JsonApiAutomationOutRelationshipsAutomationResults - a model defined in OpenAPI Args: data (JsonApiAutomationResultToManyLinkage): @@ -197,7 +197,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiAutomationOutRelationshipsAutomationResult - a model defined in OpenAPI + """JsonApiAutomationOutRelationshipsAutomationResults - a model defined in OpenAPI Args: data (JsonApiAutomationResultToManyLinkage): diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_attributes.py index a181ae817..b7247ddc4 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_attributes.py @@ -63,6 +63,12 @@ class JsonApiAutomationResultOutAttributes(ModelNormal): } validations = { + ('error_message',): { + 'max_length': 10000, + }, + ('trace_id',): { + 'max_length': 255, + }, } @cached_property @@ -88,6 +94,8 @@ def openapi_types(): return { 'executed_at': (datetime,), # noqa: E501 'status': (str,), # noqa: E501 + 'error_message': (str,), # noqa: E501 + 'trace_id': (str,), # noqa: E501 } @cached_property @@ -98,6 +106,8 @@ def discriminator(): attribute_map = { 'executed_at': 'executedAt', # noqa: E501 'status': 'status', # noqa: E501 + 'error_message': 'errorMessage', # noqa: E501 + 'trace_id': 'traceId', # noqa: E501 } read_only_vars = { @@ -145,6 +155,8 @@ def _from_openapi_data(cls, executed_at, status, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + error_message (str): [optional] # noqa: E501 + trace_id (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -236,6 +248,8 @@ def __init__(self, executed_at, status, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + error_message (str): [optional] # noqa: E501 + trace_id (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py index b50423bfd..3da64ba87 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 @@ -66,6 +66,7 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'METADATA_LOCALE': "METADATA_LOCALE", 'FORMAT_LOCALE': "FORMAT_LOCALE", 'MAPBOX_TOKEN': "MAPBOX_TOKEN", + 'AG_GRID_TOKEN': "AG_GRID_TOKEN", 'WEEK_START': "WEEK_START", 'SHOW_HIDDEN_CATALOG_ITEMS': "SHOW_HIDDEN_CATALOG_ITEMS", 'OPERATOR_OVERRIDES': "OPERATOR_OVERRIDES", @@ -83,6 +84,7 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", 'ATTACHMENT_LINK_TTL': "ATTACHMENT_LINK_TTL", 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE': "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS': "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py new file mode 100644 index 000000000..c3c2b075d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py @@ -0,0 +1,304 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_automation_out_relationships import JsonApiAutomationOutRelationships + from gooddata_api_client.model.json_api_workspace_automation_out_attributes import JsonApiWorkspaceAutomationOutAttributes + globals()['JsonApiAutomationOutRelationships'] = JsonApiAutomationOutRelationships + globals()['JsonApiWorkspaceAutomationOutAttributes'] = JsonApiWorkspaceAutomationOutAttributes + + +class JsonApiWorkspaceAutomationOut(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'WORKSPACEAUTOMATION': "workspaceAutomation", + }, + } + + 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': (JsonApiWorkspaceAutomationOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'relationships': (JsonApiAutomationOutRelationships,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'relationships': 'relationships', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceAutomationOut - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceAutomationOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceAutomation", must be one of ["workspaceAutomation", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceAutomation") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + """JsonApiWorkspaceAutomationOut - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceAutomationOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceAutomation", must be one of ["workspaceAutomation", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceAutomation") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_attributes.py new file mode 100644 index 000000000..09c2dcc69 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_attributes.py @@ -0,0 +1,381 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + 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_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert + from gooddata_api_client.model.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner + 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_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata + from gooddata_api_client.model.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule + from gooddata_api_client.model.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner + 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()['JsonApiAutomationInAttributesDashboardTabularExportsInner'] = JsonApiAutomationInAttributesDashboardTabularExportsInner + globals()['JsonApiAutomationInAttributesExternalRecipientsInner'] = JsonApiAutomationInAttributesExternalRecipientsInner + globals()['JsonApiAutomationInAttributesImageExportsInner'] = JsonApiAutomationInAttributesImageExportsInner + globals()['JsonApiAutomationInAttributesMetadata'] = JsonApiAutomationInAttributesMetadata + globals()['JsonApiAutomationInAttributesRawExportsInner'] = JsonApiAutomationInAttributesRawExportsInner + globals()['JsonApiAutomationInAttributesSchedule'] = JsonApiAutomationInAttributesSchedule + globals()['JsonApiAutomationInAttributesSlidesExportsInner'] = JsonApiAutomationInAttributesSlidesExportsInner + globals()['JsonApiAutomationInAttributesTabularExportsInner'] = JsonApiAutomationInAttributesTabularExportsInner + globals()['JsonApiAutomationInAttributesVisualExportsInner'] = JsonApiAutomationInAttributesVisualExportsInner + + +class JsonApiWorkspaceAutomationOutAttributes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('state',): { + 'ACTIVE': "ACTIVE", + 'PAUSED': "PAUSED", + }, + } + + validations = { + ('workspace_id',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('details',): { + }, + ('title',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'workspace_id': (str,), # noqa: E501 + 'alert': (JsonApiAutomationInAttributesAlert,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'dashboard_tabular_exports': ([JsonApiAutomationInAttributesDashboardTabularExportsInner],), # noqa: E501 + 'description': (str,), # noqa: E501 + 'details': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'external_recipients': ([JsonApiAutomationInAttributesExternalRecipientsInner],), # noqa: E501 + 'image_exports': ([JsonApiAutomationInAttributesImageExportsInner],), # noqa: E501 + 'metadata': (JsonApiAutomationInAttributesMetadata,), # noqa: E501 + 'modified_at': (datetime,), # noqa: E501 + 'raw_exports': ([JsonApiAutomationInAttributesRawExportsInner],), # noqa: E501 + 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 + 'slides_exports': ([JsonApiAutomationInAttributesSlidesExportsInner],), # noqa: E501 + 'state': (str,), # noqa: E501 + 'tabular_exports': ([JsonApiAutomationInAttributesTabularExportsInner],), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + 'visual_exports': ([JsonApiAutomationInAttributesVisualExportsInner],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'workspace_id': 'workspaceId', # noqa: E501 + 'alert': 'alert', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'dashboard_tabular_exports': 'dashboardTabularExports', # noqa: E501 + 'description': 'description', # noqa: E501 + 'details': 'details', # noqa: E501 + 'external_recipients': 'externalRecipients', # noqa: E501 + 'image_exports': 'imageExports', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'raw_exports': 'rawExports', # noqa: E501 + 'schedule': 'schedule', # noqa: E501 + 'slides_exports': 'slidesExports', # noqa: E501 + 'state': 'state', # noqa: E501 + 'tabular_exports': 'tabularExports', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + 'visual_exports': 'visualExports', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, workspace_id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceAutomationOutAttributes - a model defined in OpenAPI + + Args: + workspace_id (str): ID of the workspace to which the automation belongs. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + details ({str: (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 + image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 + metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 + modified_at (datetime): [optional] # noqa: E501 + raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 + schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 + slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 + state (str): Current state of the automation.. [optional] # noqa: E501 + tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [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.workspace_id = workspace_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, workspace_id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceAutomationOutAttributes - a model defined in OpenAPI + + Args: + workspace_id (str): ID of the workspace to which the automation belongs. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + details ({str: (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 + image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 + metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 + modified_at (datetime): [optional] # noqa: E501 + raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 + schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 + slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 + state (str): Current state of the automation.. [optional] # noqa: E501 + tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [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.workspace_id = workspace_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.py new file mode 100644 index 000000000..53440c9b9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.py @@ -0,0 +1,298 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta + from gooddata_api_client.model.json_api_automation_out_includes import JsonApiAutomationOutIncludes + from gooddata_api_client.model.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta + globals()['JsonApiAutomationOutIncludes'] = JsonApiAutomationOutIncludes + globals()['JsonApiWorkspaceAutomationOutWithLinks'] = JsonApiWorkspaceAutomationOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiWorkspaceAutomationOutList(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('data',): { + }, + ('included',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ([JsonApiWorkspaceAutomationOutWithLinks],), # noqa: E501 + 'included': ([JsonApiAutomationOutIncludes],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'included': 'included', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceAutomationOutList - a model defined in OpenAPI + + Args: + data ([JsonApiWorkspaceAutomationOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + included ([JsonApiAutomationOutIncludes]): Included resources. [optional] # noqa: E501 + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceAutomationOutList - a model defined in OpenAPI + + Args: + data ([JsonApiWorkspaceAutomationOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + included ([JsonApiAutomationOutIncludes]): Included resources. [optional] # noqa: E501 + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py new file mode 100644 index 000000000..8d23b350d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py @@ -0,0 +1,355 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_automation_out_relationships import JsonApiAutomationOutRelationships + from gooddata_api_client.model.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut + from gooddata_api_client.model.json_api_workspace_automation_out_attributes import JsonApiWorkspaceAutomationOutAttributes + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiAutomationOutRelationships'] = JsonApiAutomationOutRelationships + globals()['JsonApiWorkspaceAutomationOut'] = JsonApiWorkspaceAutomationOut + globals()['JsonApiWorkspaceAutomationOutAttributes'] = JsonApiWorkspaceAutomationOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiWorkspaceAutomationOutWithLinks(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',): { + 'WORKSPACEAUTOMATION': "workspaceAutomation", + }, + } + + 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': (JsonApiWorkspaceAutomationOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'relationships': (JsonApiAutomationOutRelationships,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'relationships': 'relationships', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceAutomationOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiWorkspaceAutomationOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "workspaceAutomation", must be one of ["workspaceAutomation", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceAutomation") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """JsonApiWorkspaceAutomationOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiWorkspaceAutomationOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "workspaceAutomation", must be one of ["workspaceAutomation", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + relationships (JsonApiAutomationOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceAutomation") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + JsonApiWorkspaceAutomationOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.py b/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.py new file mode 100644 index 000000000..2f8c98fd4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class OrganizationAutomationIdentifier(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'workspace_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'workspace_id': 'workspaceId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, workspace_id, *args, **kwargs): # noqa: E501 + """OrganizationAutomationIdentifier - a model defined in OpenAPI + + Args: + id (str): + workspace_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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.workspace_id = workspace_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, workspace_id, *args, **kwargs): # noqa: E501 + """OrganizationAutomationIdentifier - a model defined in OpenAPI + + Args: + id (str): + workspace_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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.workspace_id = workspace_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.py b/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.py new file mode 100644 index 000000000..3ca8cb2b4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.organization_automation_identifier import OrganizationAutomationIdentifier + globals()['OrganizationAutomationIdentifier'] = OrganizationAutomationIdentifier + + +class OrganizationAutomationManagementBulkRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'automations': ([OrganizationAutomationIdentifier],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'automations': 'automations', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, automations, *args, **kwargs): # noqa: E501 + """OrganizationAutomationManagementBulkRequest - a model defined in OpenAPI + + Args: + automations ([OrganizationAutomationIdentifier]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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.automations = automations + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, automations, *args, **kwargs): # noqa: E501 + """OrganizationAutomationManagementBulkRequest - a model defined in OpenAPI + + Args: + automations ([OrganizationAutomationIdentifier]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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.automations = automations + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py index 9c464b3ff..e96fc6d72 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py @@ -70,6 +70,7 @@ class ResolvedSetting(ModelNormal): 'METADATA_LOCALE': "METADATA_LOCALE", 'FORMAT_LOCALE': "FORMAT_LOCALE", 'MAPBOX_TOKEN': "MAPBOX_TOKEN", + 'AG_GRID_TOKEN': "AG_GRID_TOKEN", 'WEEK_START': "WEEK_START", 'SHOW_HIDDEN_CATALOG_ITEMS': "SHOW_HIDDEN_CATALOG_ITEMS", 'OPERATOR_OVERRIDES': "OPERATOR_OVERRIDES", @@ -87,6 +88,7 @@ class ResolvedSetting(ModelNormal): 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", 'ATTACHMENT_LINK_TTL': "ATTACHMENT_LINK_TTL", 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE': "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS': "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/settings.py b/gooddata-api-client/gooddata_api_client/model/settings.py index 082eb4cde..aea90ddc8 100644 --- a/gooddata-api-client/gooddata_api_client/model/settings.py +++ b/gooddata-api-client/gooddata_api_client/model/settings.py @@ -60,6 +60,15 @@ class Settings(ModelNormal): """ allowed_values = { + ('page_orientation',): { + 'PORTRAIT': "PORTRAIT", + 'LANDSCAPE': "LANDSCAPE", + }, + ('page_size',): { + 'A3': "A3", + 'A4': "A4", + 'LETTER': "LETTER", + }, } validations = { @@ -90,11 +99,14 @@ def openapi_types(): return { 'export_info': (bool,), # noqa: E501 'merge_headers': (bool,), # noqa: E501 + 'page_orientation': (str,), # noqa: E501 + 'page_size': (str,), # noqa: E501 'pdf_page_size': (str,), # noqa: E501 'pdf_table_style': ([PdfTableStyle],), # noqa: E501 'pdf_top_left_content': (str,), # noqa: E501 'pdf_top_right_content': (str,), # noqa: E501 'show_filters': (bool,), # noqa: E501 + 'show_info_page': (bool,), # noqa: E501 } @cached_property @@ -105,11 +117,14 @@ def discriminator(): attribute_map = { 'export_info': 'exportInfo', # noqa: E501 'merge_headers': 'mergeHeaders', # noqa: E501 + 'page_orientation': 'pageOrientation', # noqa: E501 + 'page_size': 'pageSize', # noqa: E501 'pdf_page_size': 'pdfPageSize', # noqa: E501 'pdf_table_style': 'pdfTableStyle', # noqa: E501 'pdf_top_left_content': 'pdfTopLeftContent', # noqa: E501 'pdf_top_right_content': 'pdfTopRightContent', # noqa: E501 'show_filters': 'showFilters', # noqa: E501 + 'show_info_page': 'showInfoPage', # noqa: E501 } read_only_vars = { @@ -155,11 +170,14 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) export_info (bool): Include export info sheet in the exported file. Works only with `visualizationObject`. (XLSX). [optional] if omitted the server will use the default value of False # noqa: E501 merge_headers (bool): Merge equal headers in neighbouring cells. (XLSX). [optional] # noqa: E501 + page_orientation (str): Set page orientation. (PDF). [optional] if omitted the server will use the default value of "PORTRAIT" # noqa: E501 + page_size (str): Set page size. (PDF). [optional] if omitted the server will use the default value of "A4" # noqa: E501 pdf_page_size (str): Page size and orientation. (PDF). [optional] # noqa: E501 pdf_table_style ([PdfTableStyle]): Custom CSS styles for the table. (PDF, HTML). [optional] # noqa: E501 pdf_top_left_content (str): Top left header content. (PDF). [optional] # noqa: E501 pdf_top_right_content (str): Top right header content. (PDF). [optional] # noqa: E501 show_filters (bool): Print applied filters on top of the document. (PDF/HTML when visualizationObject is given). [optional] # noqa: E501 + show_info_page (bool): Show info page with export information.. [optional] if omitted the server will use the default value of False # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,11 +265,14 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) export_info (bool): Include export info sheet in the exported file. Works only with `visualizationObject`. (XLSX). [optional] if omitted the server will use the default value of False # noqa: E501 merge_headers (bool): Merge equal headers in neighbouring cells. (XLSX). [optional] # noqa: E501 + page_orientation (str): Set page orientation. (PDF). [optional] if omitted the server will use the default value of "PORTRAIT" # noqa: E501 + page_size (str): Set page size. (PDF). [optional] if omitted the server will use the default value of "A4" # noqa: E501 pdf_page_size (str): Page size and orientation. (PDF). [optional] # noqa: E501 pdf_table_style ([PdfTableStyle]): Custom CSS styles for the table. (PDF, HTML). [optional] # noqa: E501 pdf_top_left_content (str): Top left header content. (PDF). [optional] # noqa: E501 pdf_top_right_content (str): Top right header content. (PDF). [optional] # noqa: E501 show_filters (bool): Print applied filters on top of the document. (PDF/HTML when visualizationObject is given). [optional] # noqa: E501 + show_info_page (bool): Show info page with export information.. [optional] if omitted the server will use the default value of False # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.py b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.py new file mode 100644 index 000000000..acaae9d94 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.py @@ -0,0 +1,280 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class ValidateLLMEndpointByIdRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'base_url': (str,), # noqa: E501 + 'llm_model': (str,), # noqa: E501 + 'llm_organization': (str,), # noqa: E501 + 'provider': (str,), # noqa: E501 + 'token': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'base_url': 'baseUrl', # noqa: E501 + 'llm_model': 'llmModel', # noqa: E501 + 'llm_organization': 'llmOrganization', # noqa: E501 + 'provider': 'provider', # noqa: E501 + 'token': 'token', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ValidateLLMEndpointByIdRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + base_url (str): Base URL for the LLM endpoint validation. [optional] # noqa: E501 + llm_model (str): LLM model for the LLM endpoint validation. [optional] # noqa: E501 + llm_organization (str): Organization name for the LLM endpoint validation. [optional] # noqa: E501 + provider (str): Provider for the LLM endpoint validation. [optional] # noqa: E501 + token (str): Token for the LLM endpoint validation. [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 + """ValidateLLMEndpointByIdRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + base_url (str): Base URL for the LLM endpoint validation. [optional] # noqa: E501 + llm_model (str): LLM model for the LLM endpoint validation. [optional] # noqa: E501 + llm_organization (str): Organization name for the LLM endpoint validation. [optional] # noqa: E501 + provider (str): Provider for the LLM endpoint validation. [optional] # noqa: E501 + token (str): Token for the LLM endpoint validation. [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/workspace_automation_identifier.py b/gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.py new file mode 100644 index 000000000..96efc9be5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.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 WorkspaceAutomationIdentifier(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """WorkspaceAutomationIdentifier - a model defined in OpenAPI + + Args: + id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """WorkspaceAutomationIdentifier - a model defined in OpenAPI + + Args: + id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.py b/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.py new file mode 100644 index 000000000..9e3181892 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.workspace_automation_identifier import WorkspaceAutomationIdentifier + globals()['WorkspaceAutomationIdentifier'] = WorkspaceAutomationIdentifier + + +class WorkspaceAutomationManagementBulkRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'automations': ([WorkspaceAutomationIdentifier],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'automations': 'automations', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, automations, *args, **kwargs): # noqa: E501 + """WorkspaceAutomationManagementBulkRequest - a model defined in OpenAPI + + Args: + automations ([WorkspaceAutomationIdentifier]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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.automations = automations + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, automations, *args, **kwargs): # noqa: E501 + """WorkspaceAutomationManagementBulkRequest - a model defined in OpenAPI + + Args: + automations ([WorkspaceAutomationIdentifier]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its 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.automations = automations + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a 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 e380f347a..abbee414e 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -385,7 +385,7 @@ from gooddata_api_client.model.json_api_automation_out_includes import JsonApiAutomationOutIncludes from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList from gooddata_api_client.model.json_api_automation_out_relationships import JsonApiAutomationOutRelationships -from gooddata_api_client.model.json_api_automation_out_relationships_automation_result import JsonApiAutomationOutRelationshipsAutomationResult +from gooddata_api_client.model.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks from gooddata_api_client.model.json_api_automation_patch import JsonApiAutomationPatch from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument @@ -742,6 +742,10 @@ from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument from gooddata_api_client.model.json_api_visualization_object_to_many_linkage import JsonApiVisualizationObjectToManyLinkage from gooddata_api_client.model.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage +from gooddata_api_client.model.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut +from gooddata_api_client.model.json_api_workspace_automation_out_attributes import JsonApiWorkspaceAutomationOutAttributes +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.model.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks from gooddata_api_client.model.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn from gooddata_api_client.model.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument @@ -832,6 +836,8 @@ from gooddata_api_client.model.notifications_meta_total import NotificationsMetaTotal from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.model.organization_automation_identifier import OrganizationAutomationIdentifier +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment from gooddata_api_client.model.over import Over from gooddata_api_client.model.page_metadata import PageMetadata @@ -950,6 +956,7 @@ from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment from gooddata_api_client.model.user_permission import UserPermission from gooddata_api_client.model.validate_by_item import ValidateByItem +from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse from gooddata_api_client.model.value import Value @@ -962,6 +969,8 @@ 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_automation_identifier import WorkspaceAutomationIdentifier +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest 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 358b04111..d3e74d8c3 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -557,6 +557,10 @@ "pattern": { "description": "ICU formatting pattern like 'y', 'dd.MM.y', etc.", "type": "string" + }, + "timezone": { + "description": "Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.", + "type": "string" } }, "required": [ @@ -3477,6 +3481,31 @@ ], "type": "object" }, + "ValidateLLMEndpointByIdRequest": { + "properties": { + "baseUrl": { + "description": "Base URL for the LLM endpoint validation", + "type": "string" + }, + "llmModel": { + "description": "LLM model for the LLM endpoint validation", + "type": "string" + }, + "llmOrganization": { + "description": "Organization name for the LLM endpoint validation", + "type": "string" + }, + "provider": { + "description": "Provider for the LLM endpoint validation", + "type": "string" + }, + "token": { + "description": "Token for the LLM endpoint validation", + "type": "string" + } + }, + "type": "object" + }, "ValidateLLMEndpointRequest": { "properties": { "baseUrl": { @@ -3531,7 +3560,7 @@ }, "openapi": "3.0.1", "paths": { - "/api/v1/actions/ai/validateLlmEndpoint": { + "/api/v1/actions/ai/llmEndpoint/test": { "post": { "description": "Validates LLM endpoint with provided parameters.", "operationId": "validateLLMEndpoint", @@ -3564,6 +3593,48 @@ ] } }, + "/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test": { + "post": { + "description": "Validates existing LLM endpoint with provided parameters and updates it if they are valid.", + "operationId": "validateLLMEndpointById", + "parameters": [ + { + "in": "path", + "name": "llmEndpointId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateLLMEndpointByIdRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateLLMEndpointResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "Validate LLM Endpoint By Id", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { "post": { "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index 27eea34ec..527f5b078 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -797,6 +797,7 @@ "UiLocalization", "Tier", "UserCount", + "ManagedIdpUserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", @@ -1050,6 +1051,10 @@ "pattern": { "description": "ICU formatting pattern like 'y', 'dd.MM.y', etc.", "type": "string" + }, + "timezone": { + "description": "Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.", + "type": "string" } }, "required": [ @@ -5281,6 +5286,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -5297,7 +5303,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "example": "TIMEZONE", "type": "string" @@ -6629,6 +6636,7 @@ "UiLocalization", "Tier", "UserCount", + "ManagedIdpUserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", @@ -9981,7 +9989,7 @@ ], "type": "object" }, - "automationResult": { + "automationResults": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" @@ -10471,6 +10479,10 @@ "properties": { "attributes": { "properties": { + "errorMessage": { + "maxLength": 10000, + "type": "string" + }, "executedAt": { "description": "Timestamp of the last automation run.", "format": "date-time", @@ -10483,6 +10495,10 @@ "FAILED" ], "type": "string" + }, + "traceId": { + "maxLength": 255, + "type": "string" } }, "required": [ @@ -17719,6 +17735,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -17735,7 +17752,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -17795,6 +17813,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -17811,7 +17830,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -17911,6 +17931,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -17927,7 +17948,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -19393,6 +19415,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -19409,7 +19432,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -19469,6 +19493,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -19485,7 +19510,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -20071,6 +20097,383 @@ } ] }, + "JsonApiWorkspaceAutomationOut": { + "description": "JSON:API representation of workspaceAutomation entity.", + "properties": { + "attributes": { + "properties": { + "alert": { + "properties": { + "condition": { + "$ref": "#/components/schemas/AlertCondition" + }, + "execution": { + "$ref": "#/components/schemas/AlertAfm" + }, + "trigger": { + "default": "ALWAYS", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", + "enum": [ + "ALWAYS", + "ONCE" + ], + "type": "string" + } + }, + "required": [ + "condition", + "execution" + ], + "type": "object" + }, + "areRelationsValid": { + "type": "boolean" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "dashboardTabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/DashboardTabularExportRequestV2" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "details": { + "description": "Additional details to be included in the automated message.", + "maxLength": 10000, + "type": "object" + }, + "externalRecipients": { + "description": "External recipients of the automation action results.", + "items": { + "properties": { + "email": { + "description": "E-mail address to send notifications from.", + "format": "email", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object" + }, + "type": "array" + }, + "imageExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/ImageExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "metadata": { + "description": "Additional information for the automation.", + "maxLength": 250000, + "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, + "type": "object" + }, + "modifiedAt": { + "format": "date-time", + "type": "string" + }, + "rawExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/RawExportAutomationRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "schedule": { + "properties": { + "cron": { + "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example": "0 */30 9-17 ? * MON-FRI", + "maxLength": 255, + "type": "string" + }, + "cronDescription": { + "description": "Human-readable description of the cron expression.", + "readOnly": true, + "type": "string" + }, + "firstRun": { + "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example": "2025-01-01T12:00:00Z", + "format": "date-time", + "type": "string" + }, + "timezone": { + "description": "Timezone in which the schedule is defined.", + "example": "Europe/Prague", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "cron", + "timezone" + ], + "type": "object" + }, + "slidesExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/SlidesExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "state": { + "description": "Current state of the automation.", + "enum": [ + "ACTIVE", + "PAUSED" + ], + "type": "string" + }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "workspaceId": { + "description": "ID of the workspace to which the automation belongs.", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "workspaceId" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "analyticalDashboard": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "automationResults": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "exportDefinitions": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "notificationChannel": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "recipients": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceAutomation" + ], + "example": "workspaceAutomation", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceAutomationOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiAutomationOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceAutomationOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, "JsonApiWorkspaceDataFilterIn": { "description": "JSON:API representation of workspaceDataFilter entity.", "properties": { @@ -21223,6 +21626,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -21239,7 +21643,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -21299,6 +21704,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -21315,7 +21721,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -21441,6 +21848,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -21457,7 +21865,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -21517,6 +21926,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -21533,7 +21943,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -22221,6 +22632,35 @@ }, "type": "object" }, + "OrganizationAutomationIdentifier": { + "properties": { + "id": { + "type": "string" + }, + "workspaceId": { + "type": "string" + } + }, + "required": [ + "id", + "workspaceId" + ], + "type": "object" + }, + "OrganizationAutomationManagementBulkRequest": { + "properties": { + "automations": { + "items": { + "$ref": "#/components/schemas/OrganizationAutomationIdentifier" + }, + "type": "array" + } + }, + "required": [ + "automations" + ], + "type": "object" + }, "OrganizationPermissionAssignment": { "description": "Organization permission assignments", "properties": { @@ -22333,6 +22773,7 @@ "type": "object" }, "PdfTableStyle": { + "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { @@ -23214,6 +23655,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -23230,7 +23672,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "example": "TIMEZONE", "type": "string" @@ -23816,12 +24259,33 @@ "example": true, "type": "boolean" }, + "pageOrientation": { + "default": "PORTRAIT", + "description": "Set page orientation. (PDF)", + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], + "type": "string" + }, + "pageSize": { + "default": "A4", + "description": "Set page size. (PDF)", + "enum": [ + "A3", + "A4", + "LETTER" + ], + "type": "string" + }, "pdfPageSize": { + "deprecated": true, "description": "Page size and orientation. (PDF)", "example": "a4 landscape", "type": "string" }, "pdfTableStyle": { + "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { @@ -23840,19 +24304,27 @@ "type": "array" }, "pdfTopLeftContent": { + "deprecated": true, "description": "Top left header content. (PDF)", "example": "Good", "type": "string" }, "pdfTopRightContent": { + "deprecated": true, "description": "Top right header content. (PDF)", "example": "Morning", "type": "string" }, "showFilters": { + "deprecated": true, "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", "example": false, "type": "boolean" + }, + "showInfoPage": { + "default": false, + "description": "Show info page with export information.", + "type": "boolean" } }, "type": "object" @@ -25159,6 +25631,31 @@ ], "type": "object" }, + "ValidateLLMEndpointByIdRequest": { + "properties": { + "baseUrl": { + "description": "Base URL for the LLM endpoint validation", + "type": "string" + }, + "llmModel": { + "description": "LLM model for the LLM endpoint validation", + "type": "string" + }, + "llmOrganization": { + "description": "Organization name for the LLM endpoint validation", + "type": "string" + }, + "provider": { + "description": "Provider for the LLM endpoint validation", + "type": "string" + }, + "token": { + "description": "Token for the LLM endpoint validation", + "type": "string" + } + }, + "type": "object" + }, "ValidateLLMEndpointRequest": { "properties": { "baseUrl": { @@ -25501,6 +25998,31 @@ ], "type": "object" }, + "WorkspaceAutomationIdentifier": { + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "WorkspaceAutomationManagementBulkRequest": { + "properties": { + "automations": { + "items": { + "$ref": "#/components/schemas/WorkspaceAutomationIdentifier" + }, + "type": "array" + } + }, + "required": [ + "automations" + ], + "type": "object" + }, "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": { @@ -25731,7 +26253,7 @@ }, "openapi": "3.0.1", "paths": { - "/api/v1/actions/ai/validateLlmEndpoint": { + "/api/v1/actions/ai/llmEndpoint/test": { "post": { "description": "Validates LLM endpoint with provided parameters.", "operationId": "validateLLMEndpoint", @@ -25764,6 +26286,48 @@ ] } }, + "/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test": { + "post": { + "description": "Validates existing LLM endpoint with provided parameters and updates it if they are valid.", + "operationId": "validateLLMEndpointById", + "parameters": [ + { + "in": "path", + "name": "llmEndpointId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateLLMEndpointByIdRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateLLMEndpointResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "Validate LLM Endpoint By Id", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/collectUsage": { "get": { "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", @@ -26605,6 +27169,81 @@ ] } }, + "/api/v1/actions/organization/automations/delete": { + "post": { + "operationId": "deleteOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Delete selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/pause": { + "post": { + "operationId": "pauseOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Pause selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/unpause": { + "post": { + "operationId": "unpauseOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Unpause selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, "/api/v1/actions/organization/automations/unsubscribe": { "delete": { "operationId": "unsubscribeAllAutomations", @@ -27732,6 +28371,76 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/automations/delete": { + "post": { + "operationId": "deleteWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Delete selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/pause": { + "post": { + "operationId": "pauseWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Pause selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/automations/trigger": { "post": { "description": "Trigger the automation in the request.", @@ -27768,6 +28477,41 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/automations/unpause": { + "post": { + "operationId": "unpauseWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Unpause selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe": { "delete": { "operationId": "unsubscribeWorkspaceAutomations", @@ -27791,6 +28535,39 @@ "Automations", "actions" ] + }, + "post": { + "operationId": "unsubscribeSelectedWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Unsubscribe from selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger": { @@ -29137,7 +29914,12 @@ "responses": { "200": { "content": { - "image/png": {} + "image/png": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -29326,9 +30108,24 @@ "responses": { "200": { "content": { - "application/vnd.apache.arrow.file": {}, - "application/vnd.apache.arrow.stream": {}, - "text/csv": {} + "application/vnd.apache.arrow.file": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.apache.arrow.stream": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/csv": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -29391,6 +30188,15 @@ "schema": { "type": "string" } + }, + { + "in": "header", + "name": "X-Gdc-Debug", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { @@ -29453,8 +30259,18 @@ "responses": { "200": { "content": { - "application/pdf": {}, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": {} + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -29682,10 +30498,30 @@ "responses": { "200": { "content": { - "application/pdf": {}, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {}, - "text/csv": {}, - "text/html": {} + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/csv": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/html": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -29754,6 +30590,15 @@ "schema": { "type": "string" } + }, + { + "in": "header", + "name": "X-Gdc-Debug", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { @@ -29816,7 +30661,12 @@ "responses": { "200": { "content": { - "application/pdf": {} + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -33440,6 +34290,106 @@ ] } }, + "/api/v1/entities/organization/workspaceAutomations": { + "get": { + "operationId": "getAllAutomations@WorkspaceAutomations", + "parameters": [ + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=workspaceId==someString;title==someString;notificationChannel.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", + "users", + "automationResults", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$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/JsonApiWorkspaceAutomationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Automations across all Workspaces", + "tags": [ + "Automations", + "entities", + "automation-organization-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/entities/organizationSettings": { "get": { "operationId": "getAllEntities@OrganizationSettings", @@ -37379,7 +38329,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -37398,7 +38348,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" @@ -37487,7 +38436,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -37506,7 +38455,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" @@ -37652,7 +38600,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -37671,7 +38619,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" @@ -37767,7 +38714,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -37786,7 +38733,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" @@ -37861,7 +38807,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -37880,7 +38826,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index 950df3fda..9a7abb9fc 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -1977,6 +1977,7 @@ "type": "object" }, "PdfTableStyle": { + "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { @@ -2553,12 +2554,33 @@ "example": true, "type": "boolean" }, + "pageOrientation": { + "default": "PORTRAIT", + "description": "Set page orientation. (PDF)", + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], + "type": "string" + }, + "pageSize": { + "default": "A4", + "description": "Set page size. (PDF)", + "enum": [ + "A3", + "A4", + "LETTER" + ], + "type": "string" + }, "pdfPageSize": { + "deprecated": true, "description": "Page size and orientation. (PDF)", "example": "a4 landscape", "type": "string" }, "pdfTableStyle": { + "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { @@ -2577,19 +2599,27 @@ "type": "array" }, "pdfTopLeftContent": { + "deprecated": true, "description": "Top left header content. (PDF)", "example": "Good", "type": "string" }, "pdfTopRightContent": { + "deprecated": true, "description": "Top right header content. (PDF)", "example": "Morning", "type": "string" }, "showFilters": { + "deprecated": true, "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", "example": false, "type": "boolean" + }, + "showInfoPage": { + "default": false, + "description": "Show info page with export information.", + "type": "boolean" } }, "type": "object" diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index 632107b7c..cea137d48 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -1142,6 +1142,7 @@ "type": "object" }, "PdfTableStyle": { + "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { @@ -1641,12 +1642,33 @@ "example": true, "type": "boolean" }, + "pageOrientation": { + "default": "PORTRAIT", + "description": "Set page orientation. (PDF)", + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], + "type": "string" + }, + "pageSize": { + "default": "A4", + "description": "Set page size. (PDF)", + "enum": [ + "A3", + "A4", + "LETTER" + ], + "type": "string" + }, "pdfPageSize": { + "deprecated": true, "description": "Page size and orientation. (PDF)", "example": "a4 landscape", "type": "string" }, "pdfTableStyle": { + "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { @@ -1665,19 +1687,27 @@ "type": "array" }, "pdfTopLeftContent": { + "deprecated": true, "description": "Top left header content. (PDF)", "example": "Good", "type": "string" }, "pdfTopRightContent": { + "deprecated": true, "description": "Top right header content. (PDF)", "example": "Morning", "type": "string" }, "showFilters": { + "deprecated": true, "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", "example": false, "type": "boolean" + }, + "showInfoPage": { + "default": false, + "description": "Show info page with export information.", + "type": "boolean" } }, "type": "object" @@ -2012,7 +2042,12 @@ "responses": { "200": { "content": { - "image/png": {} + "image/png": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -2201,9 +2236,24 @@ "responses": { "200": { "content": { - "application/vnd.apache.arrow.file": {}, - "application/vnd.apache.arrow.stream": {}, - "text/csv": {} + "application/vnd.apache.arrow.file": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.apache.arrow.stream": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/csv": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -2266,6 +2316,15 @@ "schema": { "type": "string" } + }, + { + "in": "header", + "name": "X-Gdc-Debug", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { @@ -2328,8 +2387,18 @@ "responses": { "200": { "content": { - "application/pdf": {}, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": {} + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -2557,10 +2626,30 @@ "responses": { "200": { "content": { - "application/pdf": {}, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {}, - "text/csv": {}, - "text/html": {} + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/csv": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/html": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { @@ -2629,6 +2718,15 @@ "schema": { "type": "string" } + }, + { + "in": "header", + "name": "X-Gdc-Debug", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { @@ -2691,7 +2789,12 @@ "responses": { "200": { "content": { - "application/pdf": {} + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + } }, "description": "Binary export result.", "headers": { diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index 411e72547..461d70feb 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -404,6 +404,7 @@ "UiLocalization", "Tier", "UserCount", + "ManagedIdpUserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", @@ -3941,6 +3942,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -3957,7 +3959,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "example": "TIMEZONE", "type": "string" @@ -4967,6 +4970,7 @@ "UiLocalization", "Tier", "UserCount", + "ManagedIdpUserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", @@ -7805,7 +7809,7 @@ ], "type": "object" }, - "automationResult": { + "automationResults": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" @@ -8295,6 +8299,10 @@ "properties": { "attributes": { "properties": { + "errorMessage": { + "maxLength": 10000, + "type": "string" + }, "executedAt": { "description": "Timestamp of the last automation run.", "format": "date-time", @@ -8307,6 +8315,10 @@ "FAILED" ], "type": "string" + }, + "traceId": { + "maxLength": 255, + "type": "string" } }, "required": [ @@ -15543,6 +15555,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -15559,7 +15572,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -15619,6 +15633,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -15635,7 +15650,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -15735,6 +15751,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -15751,7 +15768,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -17217,6 +17235,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -17233,7 +17252,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -17293,6 +17313,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -17309,7 +17330,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -17895,24 +17917,232 @@ } ] }, - "JsonApiWorkspaceDataFilterIn": { - "description": "JSON:API representation of workspaceDataFilter entity.", + "JsonApiWorkspaceAutomationOut": { + "description": "JSON:API representation of workspaceAutomation entity.", "properties": { "attributes": { "properties": { - "columnName": { - "maxLength": 255, + "alert": { + "properties": { + "condition": { + "$ref": "#/components/schemas/AlertCondition" + }, + "execution": { + "$ref": "#/components/schemas/AlertAfm" + }, + "trigger": { + "default": "ALWAYS", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", + "enum": [ + "ALWAYS", + "ONCE" + ], + "type": "string" + } + }, + "required": [ + "condition", + "execution" + ], + "type": "object" + }, + "areRelationsValid": { + "type": "boolean" + }, + "createdAt": { + "format": "date-time", "type": "string" }, + "dashboardTabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/DashboardTabularExportRequestV2" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, "description": { "maxLength": 10000, "type": "string" }, + "details": { + "description": "Additional details to be included in the automated message.", + "maxLength": 10000, + "type": "object" + }, + "externalRecipients": { + "description": "External recipients of the automation action results.", + "items": { + "properties": { + "email": { + "description": "E-mail address to send notifications from.", + "format": "email", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object" + }, + "type": "array" + }, + "imageExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/ImageExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "metadata": { + "description": "Additional information for the automation.", + "maxLength": 250000, + "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, + "type": "object" + }, + "modifiedAt": { + "format": "date-time", + "type": "string" + }, + "rawExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/RawExportAutomationRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "schedule": { + "properties": { + "cron": { + "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example": "0 */30 9-17 ? * MON-FRI", + "maxLength": 255, + "type": "string" + }, + "cronDescription": { + "description": "Human-readable description of the cron expression.", + "readOnly": true, + "type": "string" + }, + "firstRun": { + "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example": "2025-01-01T12:00:00Z", + "format": "date-time", + "type": "string" + }, + "timezone": { + "description": "Timezone in which the schedule is defined.", + "example": "Europe/Prague", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "cron", + "timezone" + ], + "type": "object" + }, + "slidesExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/SlidesExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "state": { + "description": "Current state of the automation.", + "enum": [ + "ACTIVE", + "PAUSED" + ], + "type": "string" + }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "workspaceId": { + "description": "ID of the workspace to which the automation belongs.", + "maxLength": 255, + "type": "string" } }, + "required": [ + "workspaceId" + ], "type": "object" }, "id": { @@ -17923,51 +18153,220 @@ }, "relationships": { "properties": { - "filterSettings": { + "analyticalDashboard": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" + }, + "automationResults": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "exportDefinitions": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "notificationChannel": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "recipients": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceAutomation" + ], + "example": "workspaceAutomation", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceAutomationOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiAutomationOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceAutomationOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceDataFilterIn": { + "description": "JSON:API representation of workspaceDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "columnName": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "filterSettings": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilter" + ], + "example": "workspaceDataFilter", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" }, "type": { "enum": [ @@ -19047,6 +19446,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -19063,7 +19463,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -19123,6 +19524,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -19139,7 +19541,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -19265,6 +19668,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -19281,7 +19685,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -19341,6 +19746,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -19357,7 +19763,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "type": "string" } @@ -19683,6 +20090,35 @@ }, "type": "object" }, + "OrganizationAutomationIdentifier": { + "properties": { + "id": { + "type": "string" + }, + "workspaceId": { + "type": "string" + } + }, + "required": [ + "id", + "workspaceId" + ], + "type": "object" + }, + "OrganizationAutomationManagementBulkRequest": { + "properties": { + "automations": { + "items": { + "$ref": "#/components/schemas/OrganizationAutomationIdentifier" + }, + "type": "array" + } + }, + "required": [ + "automations" + ], + "type": "object" + }, "OrganizationPermissionAssignment": { "description": "Organization permission assignments", "properties": { @@ -19761,6 +20197,7 @@ "type": "object" }, "PdfTableStyle": { + "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { @@ -20576,6 +21013,7 @@ "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", + "AG_GRID_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", @@ -20592,7 +21030,8 @@ "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" ], "example": "TIMEZONE", "type": "string" @@ -20727,12 +21166,33 @@ "example": true, "type": "boolean" }, + "pageOrientation": { + "default": "PORTRAIT", + "description": "Set page orientation. (PDF)", + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], + "type": "string" + }, + "pageSize": { + "default": "A4", + "description": "Set page size. (PDF)", + "enum": [ + "A3", + "A4", + "LETTER" + ], + "type": "string" + }, "pdfPageSize": { + "deprecated": true, "description": "Page size and orientation. (PDF)", "example": "a4 landscape", "type": "string" }, "pdfTableStyle": { + "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { @@ -20751,19 +21211,27 @@ "type": "array" }, "pdfTopLeftContent": { + "deprecated": true, "description": "Top left header content. (PDF)", "example": "Good", "type": "string" }, "pdfTopRightContent": { + "deprecated": true, "description": "Top right header content. (PDF)", "example": "Morning", "type": "string" }, "showFilters": { + "deprecated": true, "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", "example": false, "type": "boolean" + }, + "showInfoPage": { + "default": false, + "description": "Show info page with export information.", + "type": "boolean" } }, "type": "object" @@ -21577,6 +22045,31 @@ ], "type": "object" }, + "WorkspaceAutomationIdentifier": { + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "WorkspaceAutomationManagementBulkRequest": { + "properties": { + "automations": { + "items": { + "$ref": "#/components/schemas/WorkspaceAutomationIdentifier" + }, + "type": "array" + } + }, + "required": [ + "automations" + ], + "type": "object" + }, "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": { @@ -21969,36 +22462,111 @@ ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification": { + "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification": { + "post": { + "description": "Notification sets up all reports to be computed again with new data.", + "operationId": "registerUploadNotification", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "An upload notification has been successfully registered." + } + }, + "summary": "Register an upload notification", + "tags": [ + "Invalidate Cache", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/automations/delete": { + "post": { + "operationId": "deleteOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Delete selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/pause": { + "post": { + "operationId": "pauseOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Pause selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/unpause": { "post": { - "description": "Notification sets up all reports to be computed again with new data.", - "operationId": "registerUploadNotification", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" + "operationId": "unpauseOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } } - } - ], + }, + "required": true + }, "responses": { "204": { - "description": "An upload notification has been successfully registered." + "description": "No Content" } }, - "summary": "Register an upload notification", + "summary": "Unpause selected automations across all workspaces", "tags": [ - "Invalidate Cache", + "Automations", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, "/api/v1/actions/organization/automations/unsubscribe": { @@ -22818,6 +23386,111 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/automations/delete": { + "post": { + "operationId": "deleteWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Delete selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/pause": { + "post": { + "operationId": "pauseWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Pause selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/unpause": { + "post": { + "operationId": "unpauseWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Unpause selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe": { "delete": { "operationId": "unsubscribeWorkspaceAutomations", @@ -22841,6 +23514,39 @@ "Automations", "actions" ] + }, + "post": { + "operationId": "unsubscribeSelectedWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Unsubscribe from selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe": { @@ -26560,6 +27266,106 @@ ] } }, + "/api/v1/entities/organization/workspaceAutomations": { + "get": { + "operationId": "getAllAutomations@WorkspaceAutomations", + "parameters": [ + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "filter=workspaceId==someString;title==someString;notificationChannel.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", + "users", + "automationResults", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$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/JsonApiWorkspaceAutomationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Automations across all Workspaces", + "tags": [ + "Automations", + "entities", + "automation-organization-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/entities/organizationSettings": { "get": { "operationId": "getAllEntities@OrganizationSettings", @@ -30499,7 +31305,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -30518,7 +31324,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" @@ -30607,7 +31412,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -30626,7 +31431,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" @@ -30772,7 +31576,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -30791,7 +31595,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" @@ -30887,7 +31690,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -30906,7 +31709,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string" @@ -30981,7 +31783,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResult", + "example": "include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -31000,7 +31802,6 @@ "createdBy", "modifiedBy", "recipients", - "automationResult", "ALL" ], "type": "string"