queueflow 0.2.2__py3-none-any.whl → 0.4.0__py3-none-any.whl

queueflow/__init__.py

@@ -7,14 +7,14 @@
 
     REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
 
-    The version of the OpenAPI document: 1.0.0
+    The version of the OpenAPI document: 0.5.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
 
-__version__ = "0.2.2"
+__version__ = "0.4.0"
 
 # import apis into sdk package
 from queueflow.api.cron_api import CronApi
@@ -38,6 +38,8 @@ from queueflow.exceptions import ApiException
 
 # import models into sdk package
 from queueflow.models.backoff_strategy import BackoffStrategy
+from queueflow.models.cancel_jobs_request import CancelJobsRequest
+from queueflow.models.cancel_jobs_response import CancelJobsResponse
 from queueflow.models.complete_job_request import CompleteJobRequest
 from queueflow.models.create_batch_jobs_request import CreateBatchJobsRequest
 from queueflow.models.create_batch_jobs_response import CreateBatchJobsResponse
@@ -67,11 +69,18 @@ from queueflow.models.list_jobs_response import ListJobsResponse
 from queueflow.models.list_workflows_response import ListWorkflowsResponse
 from queueflow.models.on_failure import OnFailure
 from queueflow.models.on_success import OnSuccess
+from queueflow.models.queue_control_response import QueueControlResponse
+from queueflow.models.queue_stats import QueueStats
+from queueflow.models.queues_response import QueuesResponse
 from queueflow.models.ready_status import ReadyStatus
 from queueflow.models.replay_dead_letter_response import ReplayDeadLetterResponse
+from queueflow.models.replay_dead_letters_request import ReplayDeadLettersRequest
+from queueflow.models.replay_dead_letters_response import ReplayDeadLettersResponse
+from queueflow.models.replayed_dead_letter import ReplayedDeadLetter
 from queueflow.models.stats_snapshot import StatsSnapshot
 from queueflow.models.step_status import StepStatus
 from queueflow.models.tasks_response import TasksResponse
+from queueflow.models.who_am_i_response import WhoAmIResponse
 from queueflow.models.workflow import Workflow
 from queueflow.models.workflow_diagram_response import WorkflowDiagramResponse
 from queueflow.models.workflow_status import WorkflowStatus

queueflow/api/cron_api.py

@@ -5,7 +5,7 @@
 
     REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
 
-    The version of the OpenAPI document: 1.0.0
+    The version of the OpenAPI document: 0.5.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -862,6 +862,8 @@ class CronApi:
         self,
         status: Annotated[Optional[StrictStr], Field(description="Filter by status (e.g. `pending`, `completed`).")] = None,
         queue: Annotated[Optional[StrictStr], Field(description="Filter by queue name (jobs only).")] = None,
+        task_name: Annotated[Optional[StrictStr], Field(description="Filter by task name (jobs and dead letters).")] = None,
+        replayed: Annotated[Optional[StrictBool], Field(description="Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.")] = None,
         limit: Annotated[Optional[StrictInt], Field(description="Page size, 1..=100 (default 50).")] = None,
         offset: Annotated[Optional[StrictInt], Field(description="Number of records to skip (default 0).")] = None,
         order_by: Annotated[Optional[StrictStr], Field(description="`created_at ASC` or `created_at DESC` (default DESC).")] = None,
@@ -889,6 +891,10 @@ class CronApi:
         :type status: str
         :param queue: Filter by queue name (jobs only).
         :type queue: str
+        :param task_name: Filter by task name (jobs and dead letters).
+        :type task_name: str
+        :param replayed: Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.
+        :type replayed: bool
         :param limit: Page size, 1..=100 (default 50).
         :type limit: int
         :param offset: Number of records to skip (default 0).
@@ -928,6 +934,8 @@ class CronApi:
         _param = self._list_crons_serialize(
             status=status,
             queue=queue,
+            task_name=task_name,
+            replayed=replayed,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -961,6 +969,8 @@ class CronApi:
         self,
         status: Annotated[Optional[StrictStr], Field(description="Filter by status (e.g. `pending`, `completed`).")] = None,
         queue: Annotated[Optional[StrictStr], Field(description="Filter by queue name (jobs only).")] = None,
+        task_name: Annotated[Optional[StrictStr], Field(description="Filter by task name (jobs and dead letters).")] = None,
+        replayed: Annotated[Optional[StrictBool], Field(description="Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.")] = None,
         limit: Annotated[Optional[StrictInt], Field(description="Page size, 1..=100 (default 50).")] = None,
         offset: Annotated[Optional[StrictInt], Field(description="Number of records to skip (default 0).")] = None,
         order_by: Annotated[Optional[StrictStr], Field(description="`created_at ASC` or `created_at DESC` (default DESC).")] = None,
@@ -988,6 +998,10 @@ class CronApi:
         :type status: str
         :param queue: Filter by queue name (jobs only).
         :type queue: str
+        :param task_name: Filter by task name (jobs and dead letters).
+        :type task_name: str
+        :param replayed: Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.
+        :type replayed: bool
         :param limit: Page size, 1..=100 (default 50).
         :type limit: int
         :param offset: Number of records to skip (default 0).
@@ -1027,6 +1041,8 @@ class CronApi:
         _param = self._list_crons_serialize(
             status=status,
             queue=queue,
+            task_name=task_name,
+            replayed=replayed,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -1060,6 +1076,8 @@ class CronApi:
         self,
         status: Annotated[Optional[StrictStr], Field(description="Filter by status (e.g. `pending`, `completed`).")] = None,
         queue: Annotated[Optional[StrictStr], Field(description="Filter by queue name (jobs only).")] = None,
+        task_name: Annotated[Optional[StrictStr], Field(description="Filter by task name (jobs and dead letters).")] = None,
+        replayed: Annotated[Optional[StrictBool], Field(description="Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.")] = None,
         limit: Annotated[Optional[StrictInt], Field(description="Page size, 1..=100 (default 50).")] = None,
         offset: Annotated[Optional[StrictInt], Field(description="Number of records to skip (default 0).")] = None,
         order_by: Annotated[Optional[StrictStr], Field(description="`created_at ASC` or `created_at DESC` (default DESC).")] = None,
@@ -1087,6 +1105,10 @@ class CronApi:
         :type status: str
         :param queue: Filter by queue name (jobs only).
         :type queue: str
+        :param task_name: Filter by task name (jobs and dead letters).
+        :type task_name: str
+        :param replayed: Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.
+        :type replayed: bool
         :param limit: Page size, 1..=100 (default 50).
         :type limit: int
         :param offset: Number of records to skip (default 0).
@@ -1126,6 +1148,8 @@ class CronApi:
         _param = self._list_crons_serialize(
             status=status,
             queue=queue,
+            task_name=task_name,
+            replayed=replayed,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -1154,6 +1178,8 @@ class CronApi:
         self,
         status,
         queue,
+        task_name,
+        replayed,
         limit,
         offset,
         order_by,
@@ -1191,6 +1217,14 @@ class CronApi:
             
             _query_params.append(('queue', queue))
             
+        if task_name is not None:
+            
+            _query_params.append(('task_name', task_name))
+            
+        if replayed is not None:
+            
+            _query_params.append(('replayed', replayed))
+            
         if limit is not None:
             
             _query_params.append(('limit', limit))

queueflow/api/dlq_api.py

@@ -5,7 +5,7 @@
 
     REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
 
-    The version of the OpenAPI document: 1.0.0
+    The version of the OpenAPI document: 0.5.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -23,6 +23,8 @@ from typing_extensions import Annotated
 from queueflow.models.dead_letter import DeadLetter
 from queueflow.models.list_dead_letters_response import ListDeadLettersResponse
 from queueflow.models.replay_dead_letter_response import ReplayDeadLetterResponse
+from queueflow.models.replay_dead_letters_request import ReplayDeadLettersRequest
+from queueflow.models.replay_dead_letters_response import ReplayDeadLettersResponse
 
 from queueflow.api_client import ApiClient, RequestSerialized
 from queueflow.api_response import ApiResponse
@@ -314,6 +316,8 @@ class DlqApi:
         self,
         status: Annotated[Optional[StrictStr], Field(description="Filter by status (e.g. `pending`, `completed`).")] = None,
         queue: Annotated[Optional[StrictStr], Field(description="Filter by queue name (jobs only).")] = None,
+        task_name: Annotated[Optional[StrictStr], Field(description="Filter by task name (jobs and dead letters).")] = None,
+        replayed: Annotated[Optional[StrictBool], Field(description="Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.")] = None,
         limit: Annotated[Optional[StrictInt], Field(description="Page size, 1..=100 (default 50).")] = None,
         offset: Annotated[Optional[StrictInt], Field(description="Number of records to skip (default 0).")] = None,
         order_by: Annotated[Optional[StrictStr], Field(description="`created_at ASC` or `created_at DESC` (default DESC).")] = None,
@@ -341,6 +345,10 @@ class DlqApi:
         :type status: str
         :param queue: Filter by queue name (jobs only).
         :type queue: str
+        :param task_name: Filter by task name (jobs and dead letters).
+        :type task_name: str
+        :param replayed: Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.
+        :type replayed: bool
         :param limit: Page size, 1..=100 (default 50).
         :type limit: int
         :param offset: Number of records to skip (default 0).
@@ -380,6 +388,8 @@ class DlqApi:
         _param = self._list_dead_letters_serialize(
             status=status,
             queue=queue,
+            task_name=task_name,
+            replayed=replayed,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -413,6 +423,8 @@ class DlqApi:
         self,
         status: Annotated[Optional[StrictStr], Field(description="Filter by status (e.g. `pending`, `completed`).")] = None,
         queue: Annotated[Optional[StrictStr], Field(description="Filter by queue name (jobs only).")] = None,
+        task_name: Annotated[Optional[StrictStr], Field(description="Filter by task name (jobs and dead letters).")] = None,
+        replayed: Annotated[Optional[StrictBool], Field(description="Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.")] = None,
         limit: Annotated[Optional[StrictInt], Field(description="Page size, 1..=100 (default 50).")] = None,
         offset: Annotated[Optional[StrictInt], Field(description="Number of records to skip (default 0).")] = None,
         order_by: Annotated[Optional[StrictStr], Field(description="`created_at ASC` or `created_at DESC` (default DESC).")] = None,
@@ -440,6 +452,10 @@ class DlqApi:
         :type status: str
         :param queue: Filter by queue name (jobs only).
         :type queue: str
+        :param task_name: Filter by task name (jobs and dead letters).
+        :type task_name: str
+        :param replayed: Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.
+        :type replayed: bool
         :param limit: Page size, 1..=100 (default 50).
         :type limit: int
         :param offset: Number of records to skip (default 0).
@@ -479,6 +495,8 @@ class DlqApi:
         _param = self._list_dead_letters_serialize(
             status=status,
             queue=queue,
+            task_name=task_name,
+            replayed=replayed,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -512,6 +530,8 @@ class DlqApi:
         self,
         status: Annotated[Optional[StrictStr], Field(description="Filter by status (e.g. `pending`, `completed`).")] = None,
         queue: Annotated[Optional[StrictStr], Field(description="Filter by queue name (jobs only).")] = None,
+        task_name: Annotated[Optional[StrictStr], Field(description="Filter by task name (jobs and dead letters).")] = None,
+        replayed: Annotated[Optional[StrictBool], Field(description="Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.")] = None,
         limit: Annotated[Optional[StrictInt], Field(description="Page size, 1..=100 (default 50).")] = None,
         offset: Annotated[Optional[StrictInt], Field(description="Number of records to skip (default 0).")] = None,
         order_by: Annotated[Optional[StrictStr], Field(description="`created_at ASC` or `created_at DESC` (default DESC).")] = None,
@@ -539,6 +559,10 @@ class DlqApi:
         :type status: str
         :param queue: Filter by queue name (jobs only).
         :type queue: str
+        :param task_name: Filter by task name (jobs and dead letters).
+        :type task_name: str
+        :param replayed: Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.
+        :type replayed: bool
         :param limit: Page size, 1..=100 (default 50).
         :type limit: int
         :param offset: Number of records to skip (default 0).
@@ -578,6 +602,8 @@ class DlqApi:
         _param = self._list_dead_letters_serialize(
             status=status,
             queue=queue,
+            task_name=task_name,
+            replayed=replayed,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -606,6 +632,8 @@ class DlqApi:
         self,
         status,
         queue,
+        task_name,
+        replayed,
         limit,
         offset,
         order_by,
@@ -643,6 +671,14 @@ class DlqApi:
             
             _query_params.append(('queue', queue))
             
+        if task_name is not None:
+            
+            _query_params.append(('task_name', task_name))
+            
+        if replayed is not None:
+            
+            _query_params.append(('replayed', replayed))
+            
         if limit is not None:
             
             _query_params.append(('limit', limit))
@@ -994,3 +1030,280 @@ class DlqApi:
         )
 
 
+
+
+    @validate_call
+    def replay_dead_letters(
+        self,
+        replay_dead_letters_request: ReplayDeadLettersRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ReplayDeadLettersResponse:
+        """replay_dead_letters
+
+
+        :param replay_dead_letters_request: (required)
+        :type replay_dead_letters_request: ReplayDeadLettersRequest
+        :param _request_timeout: 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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._replay_dead_letters_serialize(
+            replay_dead_letters_request=replay_dead_letters_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ReplayDeadLettersResponse",
+            '401': "ErrorBody",
+            '403': "ErrorBody",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def replay_dead_letters_with_http_info(
+        self,
+        replay_dead_letters_request: ReplayDeadLettersRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ReplayDeadLettersResponse]:
+        """replay_dead_letters
+
+
+        :param replay_dead_letters_request: (required)
+        :type replay_dead_letters_request: ReplayDeadLettersRequest
+        :param _request_timeout: 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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._replay_dead_letters_serialize(
+            replay_dead_letters_request=replay_dead_letters_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ReplayDeadLettersResponse",
+            '401': "ErrorBody",
+            '403': "ErrorBody",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def replay_dead_letters_without_preload_content(
+        self,
+        replay_dead_letters_request: ReplayDeadLettersRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """replay_dead_letters
+
+
+        :param replay_dead_letters_request: (required)
+        :type replay_dead_letters_request: ReplayDeadLettersRequest
+        :param _request_timeout: 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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._replay_dead_letters_serialize(
+            replay_dead_letters_request=replay_dead_letters_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ReplayDeadLettersResponse",
+            '401': "ErrorBody",
+            '403': "ErrorBody",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _replay_dead_letters_serialize(
+        self,
+        replay_dead_letters_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if replay_dead_letters_request is not None:
+            _body_params = replay_dead_letters_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/api/v1/dlq/replay',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

queueflow/api/health_api.py

@@ -5,7 +5,7 @@
 
     REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
 
-    The version of the OpenAPI document: 1.0.0
+    The version of the OpenAPI document: 0.5.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.