Regenerate client from commit 6b491747 of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-01-27 19:05:38.484083",
-            "spec_repo_commit": "e546294e"
+            "regenerated": "2023-01-31 18:04:55.788187",
+            "spec_repo_commit": "6b491747"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-01-27 19:05:38.496227",
-            "spec_repo_commit": "e546294e"
+            "regenerated": "2023-01-31 18:04:55.801386",
+            "spec_repo_commit": "6b491747"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -8719,6 +8719,65 @@ components:
         page:
           $ref: '#/components/schemas/Pagination'
       type: object
+    RunWorkflowWidgetDefinition:
+      description: Run workflow is widget that allows you to run a workflow from a
+        dashboard.
+      properties:
+        custom_links:
+          description: List of custom links.
+          items:
+            $ref: '#/components/schemas/WidgetCustomLink'
+          type: array
+        inputs:
+          description: Array of workflow inputs to map to dashboard template variables.
+          items:
+            $ref: '#/components/schemas/RunWorkflowWidgetInput'
+          type: array
+        time:
+          $ref: '#/components/schemas/WidgetTime'
+        title:
+          description: Title of your widget.
+          type: string
+        title_align:
+          $ref: '#/components/schemas/WidgetTextAlign'
+        title_size:
+          description: Size of the title.
+          type: string
+        type:
+          $ref: '#/components/schemas/RunWorkflowWidgetDefinitionType'
+        workflow_id:
+          description: Workflow id.
+          example: <workflow_id>
+          type: string
+      required:
+      - type
+      - workflow_id
+      type: object
+    RunWorkflowWidgetDefinitionType:
+      default: run_workflow
+      description: Type of the run workflow widget.
+      enum:
+      - run_workflow
+      example: run_workflow
+      type: string
+      x-enum-varnames:
+      - RUN_WORKFLOW
+    RunWorkflowWidgetInput:
+      description: Object to map a dashboard template variable to a workflow input.
+      properties:
+        name:
+          description: Name of the workflow input.
+          example: Environment
+          type: string
+        value:
+          description: Dashboard template variable. Can be suffixed with '.value'
+            or '.key'.
+          example: $env.value
+          type: string
+      required:
+      - name
+      - value
+      type: object
     SLOBulkDelete:
       additionalProperties:
         description: An array of all SLO timeframes.
@@ -18272,6 +18331,7 @@ components:
       - $ref: '#/components/schemas/MonitorSummaryWidgetDefinition'
       - $ref: '#/components/schemas/NoteWidgetDefinition'
       - $ref: '#/components/schemas/QueryValueWidgetDefinition'
+      - $ref: '#/components/schemas/RunWorkflowWidgetDefinition'
       - $ref: '#/components/schemas/ScatterPlotWidgetDefinition'
       - $ref: '#/components/schemas/SLOWidgetDefinition'
       - $ref: '#/components/schemas/SLOListWidgetDefinition'

docs/datadog_api_client.v1.model.rst

@@ -2570,6 +2570,27 @@ response\_meta\_attributes
    :members:
    :show-inheritance:
 
+run\_workflow\_widget\_definition
+---------------------------------
+
+.. automodule:: datadog_api_client.v1.model.run_workflow_widget_definition
+   :members:
+   :show-inheritance:
+
+run\_workflow\_widget\_definition\_type
+---------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.run_workflow_widget_definition_type
+   :members:
+   :show-inheritance:
+
+run\_workflow\_widget\_input
+----------------------------
+
+.. automodule:: datadog_api_client.v1.model.run_workflow_widget_input
+   :members:
+   :show-inheritance:
+
 scatter\_plot\_request
 ----------------------
 

examples/v1/dashboards/CreateDashboard_2610827685.py

@@ -0,0 +1,55 @@
+"""
+Create a new dashboard with run-workflow widget
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.dashboards_api import DashboardsApi
+from datadog_api_client.v1.model.dashboard import Dashboard
+from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
+from datadog_api_client.v1.model.run_workflow_widget_definition import RunWorkflowWidgetDefinition
+from datadog_api_client.v1.model.run_workflow_widget_definition_type import RunWorkflowWidgetDefinitionType
+from datadog_api_client.v1.model.run_workflow_widget_input import RunWorkflowWidgetInput
+from datadog_api_client.v1.model.widget import Widget
+from datadog_api_client.v1.model.widget_layout import WidgetLayout
+from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
+from datadog_api_client.v1.model.widget_time import WidgetTime
+
+body = Dashboard(
+    title="Example-Create_a_new_dashboard_with_run_workflow_widget",
+    description="",
+    widgets=[
+        Widget(
+            layout=WidgetLayout(
+                x=0,
+                y=0,
+                width=47,
+                height=15,
+            ),
+            definition=RunWorkflowWidgetDefinition(
+                title="Run workflow title",
+                title_size="16",
+                title_align=WidgetTextAlign.LEFT,
+                time=WidgetTime(),
+                type=RunWorkflowWidgetDefinitionType.RUN_WORKFLOW,
+                workflow_id="2e055f16-8b6a-4cdd-b452-17a34c44b160",
+                inputs=[
+                    RunWorkflowWidgetInput(
+                        name="environment",
+                        value="$env.value",
+                    ),
+                ],
+            ),
+        ),
+    ],
+    template_variables=[],
+    layout_type=DashboardLayoutType.FREE,
+    is_read_only=False,
+    notify_list=[],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.create_dashboard(body=body)
+
+    print(response)

src/datadog_api_client/v1/model/run_workflow_widget_definition.py

@@ -0,0 +1,109 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import List, Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v1.model.widget_custom_link import WidgetCustomLink
+    from datadog_api_client.v1.model.run_workflow_widget_input import RunWorkflowWidgetInput
+    from datadog_api_client.v1.model.widget_time import WidgetTime
+    from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
+    from datadog_api_client.v1.model.run_workflow_widget_definition_type import RunWorkflowWidgetDefinitionType
+
+
+class RunWorkflowWidgetDefinition(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.widget_custom_link import WidgetCustomLink
+        from datadog_api_client.v1.model.run_workflow_widget_input import RunWorkflowWidgetInput
+        from datadog_api_client.v1.model.widget_time import WidgetTime
+        from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
+        from datadog_api_client.v1.model.run_workflow_widget_definition_type import RunWorkflowWidgetDefinitionType
+
+        return {
+            "custom_links": ([WidgetCustomLink],),
+            "inputs": ([RunWorkflowWidgetInput],),
+            "time": (WidgetTime,),
+            "title": (str,),
+            "title_align": (WidgetTextAlign,),
+            "title_size": (str,),
+            "type": (RunWorkflowWidgetDefinitionType,),
+            "workflow_id": (str,),
+        }
+
+    attribute_map = {
+        "custom_links": "custom_links",
+        "inputs": "inputs",
+        "time": "time",
+        "title": "title",
+        "title_align": "title_align",
+        "title_size": "title_size",
+        "type": "type",
+        "workflow_id": "workflow_id",
+    }
+
+    def __init__(
+        self_,
+        type: RunWorkflowWidgetDefinitionType,
+        workflow_id: str,
+        custom_links: Union[List[WidgetCustomLink], UnsetType] = unset,
+        inputs: Union[List[RunWorkflowWidgetInput], UnsetType] = unset,
+        time: Union[WidgetTime, UnsetType] = unset,
+        title: Union[str, UnsetType] = unset,
+        title_align: Union[WidgetTextAlign, UnsetType] = unset,
+        title_size: Union[str, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Run workflow is widget that allows you to run a workflow from a dashboard.
+
+        :param custom_links: List of custom links.
+        :type custom_links: [WidgetCustomLink], optional
+
+        :param inputs: Array of workflow inputs to map to dashboard template variables.
+        :type inputs: [RunWorkflowWidgetInput], optional
+
+        :param time: Time setting for the widget.
+        :type time: WidgetTime, optional
+
+        :param title: Title of your widget.
+        :type title: str, optional
+
+        :param title_align: How to align the text on the widget.
+        :type title_align: WidgetTextAlign, optional
+
+        :param title_size: Size of the title.
+        :type title_size: str, optional
+
+        :param type: Type of the run workflow widget.
+        :type type: RunWorkflowWidgetDefinitionType
+
+        :param workflow_id: Workflow id.
+        :type workflow_id: str
+        """
+        if custom_links is not unset:
+            kwargs["custom_links"] = custom_links
+        if inputs is not unset:
+            kwargs["inputs"] = inputs
+        if time is not unset:
+            kwargs["time"] = time
+        if title is not unset:
+            kwargs["title"] = title
+        if title_align is not unset:
+            kwargs["title_align"] = title_align
+        if title_size is not unset:
+            kwargs["title_size"] = title_size
+        super().__init__(kwargs)
+
+        self_.type = type
+        self_.workflow_id = workflow_id

src/datadog_api_client/v1/model/run_workflow_widget_definition_type.py

@@ -0,0 +1,35 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class RunWorkflowWidgetDefinitionType(ModelSimple):
+    """
+    Type of the run workflow widget.
+
+    :param value: If omitted defaults to "run_workflow". Must be one of ["run_workflow"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "run_workflow",
+    }
+    RUN_WORKFLOW: ClassVar["RunWorkflowWidgetDefinitionType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+RunWorkflowWidgetDefinitionType.RUN_WORKFLOW = RunWorkflowWidgetDefinitionType("run_workflow")

src/datadog_api_client/v1/model/run_workflow_widget_input.py

@@ -0,0 +1,39 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+class RunWorkflowWidgetInput(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        return {
+            "name": (str,),
+            "value": (str,),
+        }
+
+    attribute_map = {
+        "name": "name",
+        "value": "value",
+    }
+
+    def __init__(self_, name: str, value: str, **kwargs):
+        """
+        Object to map a dashboard template variable to a workflow input.
+
+        :param name: Name of the workflow input.
+        :type name: str
+
+        :param value: Dashboard template variable. Can be suffixed with '.value' or '.key'.
+        :type value: str
+        """
+        super().__init__(kwargs)
+
+        self_.name = name
+        self_.value = value

src/datadog_api_client/v1/model/widget.py

@@ -34,6 +34,7 @@
     from datadog_api_client.v1.model.monitor_summary_widget_definition import MonitorSummaryWidgetDefinition
     from datadog_api_client.v1.model.note_widget_definition import NoteWidgetDefinition
     from datadog_api_client.v1.model.query_value_widget_definition import QueryValueWidgetDefinition
+    from datadog_api_client.v1.model.run_workflow_widget_definition import RunWorkflowWidgetDefinition
     from datadog_api_client.v1.model.scatter_plot_widget_definition import ScatterPlotWidgetDefinition
     from datadog_api_client.v1.model.slo_widget_definition import SLOWidgetDefinition
     from datadog_api_client.v1.model.slo_list_widget_definition import SLOListWidgetDefinition
@@ -89,6 +90,7 @@ def __init__(
             MonitorSummaryWidgetDefinition,
             NoteWidgetDefinition,
             QueryValueWidgetDefinition,
+            RunWorkflowWidgetDefinition,
             ScatterPlotWidgetDefinition,
             SLOWidgetDefinition,
             SLOListWidgetDefinition,