js7-client-python 2.0.1__py3-none-any.whl

js7/model/public/client/filter/daily_plan_order_filters.py

@@ -0,0 +1,255 @@
+from datetime import date, datetime
+from typing import List, Literal, Optional
+from pydantic import BaseModel
+
+from .element.folder import Folder
+
+
+class DailyPlanOrdersFilter(BaseModel):
+    """
+    Following elements filter the orders that should be considered.
+    All filter elements will be combined with "and".
+    The elements in the lists schedulePaths, scheduleFolders, workflowPaths, workflowFolders and controllerIds 
+    will be combined with "or".
+    """
+    
+    date_from: Optional[date] = None
+    """
+    The value has to have the format YYYY-MM-DD. The begin of the day range of the daily plan. 
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+    
+    date_to: Optional[date] = None
+    """
+    The value has to have the format YYYY-MM-DD. The end of the day range of the daily plan.
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+    
+    order_ids: Optional[List[str]] = None
+    """Filters all orders in the given daily plan that have one of the order IDs in the given list of `order_ids`."""
+    
+    workflow_paths: Optional[List[str]] = None
+    """Filters all orders in the given daily plan range that are assigned to one of the given workflows in `workflow_paths`."""
+    
+    workflow_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule assigned to a workflow
+    located in one of the given folders. Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+    
+    schedule_paths: Optional[List[str]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with one of the given schedules in `schedule_paths`.
+    """
+    
+    schedule_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule located in one of the given folders.
+    Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+    
+    workflow_tags: Optional[List[str]] = None
+    """Tags to be assigned to workflows."""
+    
+    order_tags: Optional[List[str]] = None
+    """Tags to be assigned to orders."""
+    
+    controller_ids: Optional[List[str]] = None
+    """Filters orders that have been generated for the Controller IDs that are in the list `controller_ids`."""
+    
+    states: Optional[List[Literal["PLANNED", "SUBMITTED", "FINISHED"]]] = None
+    """Filters all orders that have one of the states specified in this list of states."""
+    
+    late: bool = False
+    """If true filters all orders that are late. Late means that the current time is after the planned time+2 minutes."""
+
+
+class DailyPlanCancelOrdersFilter(BaseModel):
+    """
+    Following elements filter the orders that should be considered.
+    All filter elements will be combined with "and".
+    The elements in the lists schedulePaths, scheduleFolders, workflowPaths, workflowFolders and controllerIds 
+    will be combined with "or".
+    """
+    
+    date_from: Optional[datetime] = None
+    """
+    The value has to have the format YYYY-MM-DD. The begin of the day range of the daily plan. 
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+    
+    date_to: Optional[datetime] = None
+    """
+    The value has to have the format YYYY-MM-DD. The end of the day range of the daily plan.
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+    
+    order_ids: Optional[List[str]] = None
+    """Filters all orders in the given daily plan that have one of the order IDs in the given list of `order_ids`."""
+    
+    workflow_paths: Optional[List[str]] = None
+    """Filters all orders in the given daily plan range that are assigned to one of the given workflows in `workflow_paths`."""
+    
+    workflow_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule assigned to a workflow
+    located in one of the given folders. Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+    
+    schedule_paths: Optional[List[str]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with one of the given schedules in `schedule_paths`.
+    """
+    
+    schedule_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule located in one of the given folders.
+    Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+    
+    controller_ids: Optional[List[str]] = None
+    """Filters orders that have been generated for the Controller IDs that are in the list `controller_ids`."""
+
+
+class DailyPlanSubmitOrderFilter(BaseModel):
+    date_from: Optional[date] = None
+    """
+    The value has to have the format YYYY-MM-DD. The begin of the day range of the daily plan. 
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+    
+    date_to: Optional[date] = None
+    """
+    The value has to have the format YYYY-MM-DD. The end of the day range of the daily plan.
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+
+    schedule_paths: Optional[List[str]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with one of the given schedules in `schedule_paths`.
+    """
+
+    schedule_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule located in one of the given folders.
+    Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+    
+    workflow_paths: Optional[List[str]] = None
+    """Filters all orders in the given daily plan range that are assigned to one of the given workflows in `workflow_paths`."""
+    
+    workflow_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule assigned to a workflow
+    located in one of the given folders. Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+
+    controller_ids: Optional[List[str]] = None
+    """Filters orders that have been generated for the Controller IDs that are in the list `controller_ids`."""
+
+    order_ids: Optional[List[str]]
+    """Filters all orders in the given daily plan that have one of the order IDs in the given list of `order_ids`."""
+
+    submission_history_ids: Optional[List[int]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated by one of the given submissions. 
+    To retrieve submissionHistoryIds call /dailyplan/submissions. 
+    A submission can be manually executed or the automatically executed by the daily plan service.
+    """
+    
+class DailyPlanDeleteOrdersFilter(BaseModel):
+    date_from: Optional[date] = None
+    """
+    The value has to have the format YYYY-MM-DD. The begin of the day range of the daily plan. 
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+    
+    date_to: Optional[date] = None
+    """
+    The value has to have the format YYYY-MM-DD. The end of the day range of the daily plan.
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+
+    schedule_paths: Optional[List[str]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with one of the given schedules in `schedule_paths`.
+    """
+
+    schedule_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule located in one of the given folders.
+    Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+    
+    workflow_paths: Optional[List[str]] = None
+    """Filters all orders in the given daily plan range that are assigned to one of the given workflows in `workflow_paths`."""
+    
+    workflow_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule assigned to a workflow
+    located in one of the given folders. Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+
+    controller_ids: Optional[List[str]] = None
+    """Filters orders that have been generated for the Controller IDs that are in the list `controller_ids`."""
+    
+    order_ids: Optional[List[str]]
+    """Filters all orders in the given daily plan that have one of the order IDs in the given list of `order_ids`."""
+    
+    late: bool = False
+    """If true filters all orders that are late. Late means that the current time is after the planned time+2 minutes."""
+    
+    submission_history_ids: Optional[List[int]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated by one of the given submissions. 
+    To retrieve submissionHistoryIds call /dailyplan/submissions. 
+    A submission can be manually executed or the automatically executed by the daily plan service.
+    """
+    
+    
+class DailyPlanProjectionsFilter(BaseModel):
+    """
+    Filters all orders in the given daily plan range that have been generated by one of the given submissions. 
+    To retrieve submissionHistoryIds call /dailyplan/submissions. 
+    A submission can be manually executed or the automatically executed by the daily plan service.
+    """
+
+    date_from: Optional[date] = None
+    """
+    The value has to have the format YYYY-MM-DD. The begin of the day range of the daily plan. 
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+    
+    date_to: Optional[date] = None
+    """
+    The value has to have the format YYYY-MM-DD. The end of the day range of the daily plan.
+    Depends on the settings for daily plan timezone and daily plan period.
+    """
+    
+    schedule_paths: Optional[List[str]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with one of the given schedules in `schedule_paths`.
+    """
+    
+    schedule_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule located in one of the given folders.
+    Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+    
+    workflow_paths: Optional[List[str]] = None
+    """Filters all orders in the given daily plan range that are assigned to one of the given workflows in `workflow_paths`."""
+    
+    workflow_folders: Optional[List[Folder]] = None
+    """
+    Filters all orders in the given daily plan range that have been generated with a schedule assigned to a workflow
+    located in one of the given folders. Depending on the value for `recursive` in one of the subfolders recursively too.
+    """
+
+    without_start_time: bool = False
+    """If true, the workflows that have a start time for a day are considered. With false it is the other way round."""
+    
+    controller_ids: Optional[List[str]] = None
+    """Filters orders that have been generated for the Controller IDs that are in the list `controller_ids`."""
+    
+    

js7/model/public/client/filter/element/__init__.py

@@ -0,0 +1,3 @@
+from .folder import Folder
+from .workflow_id import WorkflowID
+__all__ = ["Folder", "WorkflowID"]

js7/model/public/client/filter/element/folder.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class Folder(BaseModel):
+    folder_path: str
+    recursive: bool = True

js7/model/public/client/filter/element/workflow_id.py

@@ -0,0 +1,10 @@
+from typing import Optional
+from pydantic import BaseModel
+
+
+class WorkflowID(BaseModel):
+    workflow_path: str
+    """Specifies the path of a workflow."""
+    
+    version_id: Optional[str] = None
+    """Optional, string	Field to specify the version of a workflow."""

js7/model/public/client/filter/export_filter.py

@@ -0,0 +1,52 @@
+from typing import List, Optional, Union
+from pydantic import BaseModel, model_validator
+
+from ..common.configurations import DraftConfiguration, DeployConfiguration, ReleaseConfiguration
+
+
+class ExportFilter(BaseModel):
+    use_short_path: Optional[bool] = None
+    """Determines if the desired objects are exported to the archive with a shortened path, e.g. if set to true the object /a/b/c/myWorkflow will be exported as /c/myWorkflow."""
+    
+    start_folder: Optional[str] = None
+    """
+    The path given determines the starting point for the relative path. E.g. `start_folder` /a/b/c results in objects starting with 
+    relative path c/... in the exported archive. Only used in conjunction with `use_short_path`.
+    """
+    
+    include_all_tags: Optional[bool] = None
+    """If false then only Tags and Tag Groups assigned the exported scheduling objects will be added to the export file."""
+    
+    for_signing: bool
+    """
+    Controls the export mode.
+
+    - `True`: Signing mode — only deployable objects are exported and prepared for cryptographic signing.
+    - `False`: Shallow copy mode — both releasable and deployable objects are included in the export.
+    """
+    
+    without_invalid_drafts: Optional[bool] = None
+    """Decides if invalid draft objects are excluded from export."""
+    
+    configurations: List[Union[DraftConfiguration, DeployConfiguration, ReleaseConfiguration]]
+    
+    @model_validator(mode="after")
+    def validate_configurations(self):
+        # Validate: for_signing
+        if self.for_signing:
+            for c in self.configurations:
+                if not isinstance(c, (DeployConfiguration, DraftConfiguration)):
+                    raise ValueError(
+                        "When 'for_signing' is set to True, only DeployConfiguration and DraftConfiguration objects are supported."
+                    )
+        # Validate: shallow_copy
+        else:
+            for c in self.configurations:
+                if not isinstance(c, (DeployConfiguration, ReleaseConfiguration)):
+                    raise ValueError(
+                        "When 'for_signing' is set to False (shallow copy mode), only DeployConfiguration and ReleaseConfiguration objects are supported."
+                    )
+
+        return self
+        
+    

js7/model/public/client/filter/export_folders_filter.py

@@ -0,0 +1,34 @@
+from typing import List, Optional, Union
+from pydantic import BaseModel
+
+from ..enum.object_types import DeployObjectType, ReleaseObjectType
+
+
+class ExportFoldersFilter(BaseModel):
+    folder_paths: List[str]
+    """Paths of the inventory directories that should be exported."""
+    
+    use_short_path: bool = False
+    """
+    Determines if the desired objects are exported to the archive with a shortened path, e.g. 
+    if set to `True` the object `/a/b/c/myWorkflow` will be exported as `/c/myWorkflow`.
+    """
+    
+    recursive: bool = True
+    """A switch to determine if the specified folders should be read recursively."""
+    
+    for_signing: bool
+    
+    object_types: Optional[List[Union[DeployObjectType, ReleaseObjectType]]] = None
+    
+    no_draft: bool = False
+    """Determines if draft configurations are excluded from export."""
+    
+    no_deployed: bool = False
+    """Determines if already deployed configurations are excluded from export."""
+    
+    no_released: bool = False
+    """Determines if already released configurations are excluded from export."""
+    
+    no_invalid: bool = False
+    """Determines if invalid draft configurations are excluded from export."""

js7/model/public/client/filter/get_order_filter.py

@@ -0,0 +1,59 @@
+from datetime import datetime
+from typing import List, Literal, Optional, Union
+from pydantic import BaseModel
+
+from .element.folder import Folder
+from .element.workflow_id import WorkflowID
+
+
+class GetOrderFilter(BaseModel):
+    order_ids: Optional[List[str]] = None
+    """Filtered response by a collection of orderIds If this parameter is specified then parameters such as workflowIds, states, folders and regex where applicable are ignored."""
+
+    workflow_ids: Optional[List[WorkflowID]] = None
+    """
+    Filtered response by a collection of workflows specified by its path and optional version If this parameter 
+    is specified then parameters such as folders, states, regex and agentName where applicable are ignored.
+    """
+    
+    order_tags: Optional[List[str]] = None
+    
+    folders: Optional[List[Folder]] = None
+    """Limits the result to a collection of folders."""
+    
+    compact: bool = False
+    """A compact response is returned if this parameter is 'true'."""
+    
+    regex: Optional[str] = None
+    """Regular expression to filter the collection."""
+    
+    states: Optional[List[Literal["PENDING", "SCHEDULED", "SCHEDULED", "SCHEDULED", "SUSPENDED", "WAITING", "PROMPTING", "FAILED", "BLOCKED"]]] = None
+    """Filtered all orders with states."""
+    
+    state_date_from: Optional[Union[str, datetime]] = None
+    """
+    Filters those orders whose current status is younger than the specified point in time.
+    
+    0 or [number][smhdwMy] (where smhdwMy unit for second, minute, etc) or ISO 8601 timestamp.
+    """
+    
+    state_date_to: Optional[Union[str, datetime]] = None
+    """
+    Filters those orders whose current status is older than the specified point in time.
+    
+    0 or [number][smhdwMy] (where smhdwMy unit for second, minute, etc) or ISO 8601 timestamp.
+    """
+    
+    date_to: Optional[datetime] = None
+    """Filters Orders whose schedule is before a date."""
+    
+    timezone: Optional[str] = None
+    """If this parameter is set then it beats the time offset of absolute dates in `date_to`."""
+    
+    limit: Optional[int] = None
+    """Limits the number of resulting items, -1=unlimited."""
+    
+    without_workflow_tags: Optional[bool] = None
+    """if true then response doesn't contain 'workflowsTagPerWorkflow'"""
+    
+    workflow_tags: Optional[List[str]] = None

js7/model/public/client/filter/order_history_filter.py

@@ -0,0 +1,113 @@
+from typing import List, Literal, Optional
+from pydantic import BaseModel
+
+from .element.folder import Folder
+
+class OrderHistoryFilter(BaseModel):
+    date_from: Optional[str] = None
+    """
+    The value has multiple formats
+    - Filters items starting from a date.
+    - an ISO 8601 date format with the time offset and milliseconds being optional, e.g.
+        - YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)]
+        - YYYY-MM-DDThh:mm:ss[.s][+01:00]
+        - YYYY-MM-DDThh:mm:ss[.s][+0100]
+        - YYYY-MM-DDThh:mm:ss[.s][+01]
+    - a format for a period relative to the current time, e.g. 6h, 12h, 1d, 1w that specifies the quantity followed by a qualifier:
+        - s (seconds)
+        - m (minutes)
+        - h (hours)
+        - d (days)
+        - w (weeks)
+        - M (months)
+        - y (years)
+    - a time offset is optional (e.g. 2d+02:00)
+        - it can also be specified with the parameter `timezone`
+        - if `timezone` is undefined then UTC is used
+    - the value 0 indicates the current time
+    """
+    
+    date_to: Optional[str] = None
+    """
+    The value has multiple formats
+    - Filters items starting from a date.
+    - an ISO 8601 date format with the time offset and milliseconds being optional, e.g.
+        - YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)]
+        - YYYY-MM-DDThh:mm:ss[.s][+01:00]
+        - YYYY-MM-DDThh:mm:ss[.s][+0100]
+        - YYYY-MM-DDThh:mm:ss[.s][+01]
+    - a format for a period relative to the current time, e.g. 6h, 12h, 1d, 1w that specifies the quantity followed by a qualifier:
+        - s (seconds)
+        - m (minutes)
+        - h (hours)
+        - d (days)
+        - w (weeks)
+        - M (months)
+        - y (years)
+    - a time offset is optional (e.g. 2d+02:00)
+        - it can also be specified with the parameter `timezone`
+        - if `timezone` is undefined then UTC is used
+    - the value 0 indicates the current time
+    """
+    
+    completed_date_from: Optional[str] = None
+    """
+    The value has multiple formats
+    - Filters items starting from a date.
+    - an ISO 8601 date format with the time offset and milliseconds being optional, e.g.
+        - YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)]
+        - YYYY-MM-DDThh:mm:ss[.s][+01:00]
+        - YYYY-MM-DDThh:mm:ss[.s][+0100]
+        - YYYY-MM-DDThh:mm:ss[.s][+01]
+    - a format for a period relative to the current time, e.g. 6h, 12h, 1d, 1w that specifies the quantity followed by a qualifier:
+        - s (seconds)
+        - m (minutes)
+        - h (hours)
+        - d (days)
+        - w (weeks)
+        - M (months)
+        - y (years)
+    - a time offset is optional (e.g. 2d+02:00)
+        - it can also be specified with the parameter `timezone`
+        - if `timezone` is undefined then UTC is used
+    - the value 0 indicates the current time
+    """
+    
+    completed_date_to: Optional[str] = None
+    """
+    The value has multiple formats
+    - Filters items starting from a date.
+    - an ISO 8601 date format with the time offset and milliseconds being optional, e.g.
+        - YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)]
+        - YYYY-MM-DDThh:mm:ss[.s][+01:00]
+        - YYYY-MM-DDThh:mm:ss[.s][+0100]
+        - YYYY-MM-DDThh:mm:ss[.s][+01]
+    - a format for a period relative to the current time, e.g. 6h, 12h, 1d, 1w that specifies the quantity followed by a qualifier:
+        - s (seconds)
+        - m (minutes)
+        - h (hours)
+        - d (days)
+        - w (weeks)
+        - M (months)
+        - y (years)
+    - a time offset is optional (e.g. 2d+02:00)
+        - it can also be specified with the parameter `timezone`
+        - if `timezone` is undefined then UTC is used
+    - the value 0 indicates the current time
+    - Filters items ending before a date
+    """
+
+    order_id: Optional[str] = None
+    """pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character."""
+    
+    workflow_name: Optional[str] = None
+    """pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character."""
+    
+    folders: Optional[List[Folder]] = None
+    """Limits the result to a collection of folders."""
+    
+    history_states: Optional[List[Literal["FAILED", "INCOMPLETE", "SUCCESSFUL"]]] = None
+    """Limits result to specified states."""
+
+    limit: int = 10000
+    """only for db history urls to restrict the number of responsed records; -1=unlimited."""

js7/model/public/client/filter/resume_order_filter.py

@@ -0,0 +1,45 @@
+from typing import Any, Dict, List, Literal, Optional, Union
+from pydantic import BaseModel
+
+from .element.workflow_id import WorkflowID
+from .element.folder import Folder
+
+
+class ResumeOrderFilter(BaseModel):
+    order_ids: Optional[List[str]] = None
+    """
+    Specified the order ids which should be modified.
+    If this parameter is specified then the parameters `workflow_ids`, folders and states where applicable are ignored.
+    """
+    
+    workflow_ids: Optional[List[WorkflowID]] = None
+    """
+    Filtered response by a collection of workflows specified by its path and optional version
+    If this parameter is specified the parameter `folders` where applicable are ignored.
+    """
+    
+    folders: Optional[List[Folder]] = None
+    """Limits the result to a collection of folders."""
+    
+    states: Optional[List[Literal["PENDING", "SCHEDULED", "SCHEDULED", "SCHEDULED", "SUSPENDED", "WAITING", "PROMPTING", "FAILED", "BLOCKED"]]] = None
+    """Filtered all orders with states."""
+    
+    force: Optional[bool] = None
+    """force execution of non-startable jobs after kill."""
+    
+    from_current_block: Optional[bool] = None
+    """Orders get the position from the beginning of the current block. Orders that are on top level in their scope are resumed from the current position."""
+    
+    position: Optional[Union[List[Union[int, str]], str]] = None
+    """The position can also be specified by the label of the instruction."""
+    
+    variables: Optional[Dict[str, Any]] = None
+    """
+    Variables can only be set for resumimg a single order that position is not at the beginning of its workflow's scope.
+    Otherwise an error is raised.
+    It change the returned variables of the previous jobs.
+    An object with key-value pairs. The value can be a string, number or boolean.
+    """
+
+    cycle_end_time: Optional[float] = None
+    """A relative cycle end time in seconds."""

js7/model/public/client/filter/suspend_order_filter.py

@@ -0,0 +1,44 @@
+from datetime import datetime
+from typing import List, Literal, Optional
+from pydantic import BaseModel
+
+from .element.workflow_id import WorkflowID
+from .element.folder import Folder
+
+
+class SuspendOrderFilter(BaseModel):
+    order_ids: Optional[List[str]] = None
+    """
+    Specified the order ids which should be modified.
+    If this parameter is specified then the parameters `workflow_ids`, folders and states where applicable are ignored.
+    """
+    
+    workflow_ids: Optional[List[WorkflowID]] = None
+    """
+    Filtered response by a collection of workflows specified by its path and optional version
+    If this parameter is specified the parameter `folders` where applicable are ignored.
+    """
+    
+    folders: Optional[List[Folder]] = None
+    """Limits the result to a collection of folders."""
+    
+    states: Optional[List[Literal["PENDING", "SCHEDULED", "SCHEDULED", "SCHEDULED", "SUSPENDED", "WAITING", "PROMPTING", "FAILED", "BLOCKED"]]] = None
+    """Filtered all orders with states."""
+    
+    date_from: Optional[datetime] = None
+    """Filters items starting from a date."""
+    
+    date_to: Optional[datetime] = None
+    """Filters items ending before a date."""
+    
+    timezone: Optional[str] = None
+    """If this parameter is set then it beats the time offset in `date_from` and `date_to`."""
+    
+    reset: Optional[bool] = None
+    """reset any instruction that is currently executed."""
+    
+    kill: Optional[bool] = None
+    """without a signal(false) or with SIGTERM(true)."""
+    
+    deep: Optional[bool] = None
+    """if true then child orders are also processed."""