regenerate close job and complete job with updated signature (#33017)

Author: sarkar-rajarshi

sdk/communication/azure-communication-jobrouter/CHANGELOG.md

@@ -27,11 +27,15 @@
   - Create and update methods have been removed for `RouterWorker`. Use `upsert_worker` instead.
   - `list_jobs` returns `(Async)Iterable[RouterJob]` instead of `(Async)Iterable[RouterJobItem]`
   - `list_workers` returns `(Async)Iterable[RouterWorker]` instead of `(Async)Iterable[RouterWorkerItem]`
-  - `decline_job_offer` - keyword argument `retry_offer_at: Optional[datetime]` removed from method. Use `decline_job_offer_options: Optional[Union[DeclineJobOfferOptions, JSON, IO]]` instead.
-  - `close_job` - keyword arguments `close_at: Optional[datetime]`, `disposition_code: Optional[str]`, `note: Optional[str]` removed from method. Use `close_job_options: Union[CloseJobOptions, JSON, IO]` instead.
-  - `cancel_job` - keyword arguments `disposition_code: Optional[str]`, `note: Optional[str]` removed from method. Use `cancel_job_options: Optional[Union[CancelJobOptions, JSON, IO]]` instead.
-  - `complete_job` - keyword argument `note: Optional[str]` removed from method. Use `complete_job_options: Union[CompleteJobOptions, JSON, IO]` instead.
-  - `unassign_job` - keyword argument `suspend_matching: Optional[bool]` removed from method. Use `unassign_job_options: Optional[Union[UnassignJobOptions, JSON, IO]]` instead.
+  - `decline_job_offer` - keyword argument `retry_offer_at: Optional[datetime]` removed from method. Use `options: Optional[Union[DeclineJobOfferOptions, JSON, IO]]` instead.
+  - `close_job`
+    - keyword arguments `close_at: Optional[datetime]`, `disposition_code: Optional[str]`, `note: Optional[str]` removed from method. Use `options: Optional[Union[CloseJobOptions, JSON, IO]]` instead.
+    - `assignment_id: str` added as positional argument.
+  - `cancel_job` - keyword arguments `disposition_code: Optional[str]`, `note: Optional[str]` removed from method. Use `options: Optional[Union[CancelJobOptions, JSON, IO]]` instead.
+  - `complete_job` 
+    - keyword argument `note: Optional[str]` removed from method. Use `options: Optional[Union[CompleteJobOptions, JSON, IO]]` instead.
+    - `assignment_id: str` added as positional argument.
+  - `unassign_job` - keyword argument `suspend_matching: Optional[bool]` removed from method. Use `options: Optional[Union[UnassignJobOptions, JSON, IO]]` instead.
 - `RouterJob`
   - Property `notes` - Changed from `Dict[str, ~datetime.datetime]` to `List[RouterJobNote]`
 - `ClassificationPolicy`
@@ -47,6 +51,10 @@
   - Property changed `queue_assignments: Dict[str, RouterQueueAssignment]` -> `queues: List[str]`
   - Rename `total_capacity` -> `capacity`
   - Property changed `channel_configurations: Dict[str, ChannelConfiguration]` -> `channels: List[RouterChannel]`
+- `CloseJobOptions`
+  - Removed property `assignment_id`
+- `CompleteJobOptions`
+  - Removed property `assignment_id`
 
 #### Renames
 - `ChannelConfiguration` -> `RouterChannel`
@@ -79,7 +87,7 @@
 - `ExceptionRule`
   - Add `id`
 - `ExceptionAction` and all derived classes `CancelExceptionAction`, `ManualReclassifyExceptionAction`, `ReclassifyExceptionAction`
-  - Add `id`. Property is read-only. If not provided, it will be generated by the service.
+  - Add `id`. If not provided, it will be generated by the service.
 - `RouterChannel`
   - Add `channel_id`
 

sdk/communication/azure-communication-jobrouter/README.md

@@ -254,8 +254,8 @@ from azure.communication.jobrouter.models import (
 )
 complete_job_result = router_client.complete_job(
     "jobId-1",
+    accept_job_offer_result.assignment_id,
     CompleteJobOptions(
-        assignment_id = accept_job_offer_result.assignment_id,
         note = f"Job has been completed by {router_worker.id} at {datetime.datetime.utcnow()}"
     )
 )
@@ -274,8 +274,8 @@ from azure.communication.jobrouter.models import (
 
 close_job_result = router_client.close_job(
     "jobId-1",
+    accept_job_offer_result.assignment_id,
     CloseJobOptions(
-        assignment_id = accept_job_offer_result.assignment_id,
         note = f"Job has been closed by {router_worker.id} at {datetime.datetime.utcnow()}"
     )
 )
@@ -297,8 +297,8 @@ from azure.communication.jobrouter.models import (
 
 close_job_in_future_result = router_client.close_job(
     "jobId-1",
+    accept_job_offer_result.assignment_id,
     CloseJobOptions(
-        assignment_id = accept_job_offer_result.assignment_id,
         note = f"Job has been closed by {router_worker.id} at {datetime.utcnow()}",
         close_at = datetime.utcnow() + timedelta(seconds = 2)
     )

sdk/communication/azure-communication-jobrouter/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/communication/azure-communication-jobrouter",
-  "Tag": "python/communication/azure-communication-jobrouter_1176d5225c"
+  "Tag": "python/communication/azure-communication-jobrouter_40b4f337cd"
 }

sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/_operations.py

@@ -628,7 +628,7 @@ def build_job_router_cancel_job_request(job_id: str, **kwargs: Any) -> HttpReque
     return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
 
 
-def build_job_router_complete_job_request(job_id: str, **kwargs: Any) -> HttpRequest:
+def build_job_router_complete_job_request(job_id: str, assignment_id: str, **kwargs: Any) -> HttpRequest:
     _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
     _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
 
@@ -637,9 +637,10 @@ def build_job_router_complete_job_request(job_id: str, **kwargs: Any) -> HttpReq
     accept = _headers.pop("Accept", "application/json")
 
     # Construct URL
-    _url = "/routing/jobs/{jobId}:complete"
+    _url = "/routing/jobs/{jobId}/assignments/{assignmentId}:complete"
     path_format_arguments = {
         "jobId": _SERIALIZER.url("job_id", job_id, "str"),
+        "assignmentId": _SERIALIZER.url("assignment_id", assignment_id, "str"),
     }
 
     _url: str = _url.format(**path_format_arguments)  # type: ignore
@@ -655,7 +656,7 @@ def build_job_router_complete_job_request(job_id: str, **kwargs: Any) -> HttpReq
     return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
 
 
-def build_job_router_close_job_request(job_id: str, **kwargs: Any) -> HttpRequest:
+def build_job_router_close_job_request(job_id: str, assignment_id: str, **kwargs: Any) -> HttpRequest:
     _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
     _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
 
@@ -664,9 +665,10 @@ def build_job_router_close_job_request(job_id: str, **kwargs: Any) -> HttpReques
     accept = _headers.pop("Accept", "application/json")
 
     # Construct URL
-    _url = "/routing/jobs/{jobId}:close"
+    _url = "/routing/jobs/{jobId}/assignments/{assignmentId}:close"
     path_format_arguments = {
         "jobId": _SERIALIZER.url("job_id", job_id, "str"),
+        "assignmentId": _SERIALIZER.url("assignment_id", assignment_id, "str"),
     }
 
     _url: str = _url.format(**path_format_arguments)  # type: ignore
@@ -3128,7 +3130,7 @@ def _reclassify_job(  # pylint: disable=protected-access
 
         Reclassify a job.
 
-        :param job_id: Id of the job. Required.
+        :param job_id: The id of the job. Required.
         :type job_id: str
         :param options: Request object for reclassifying a job. Is one of the following types:
          ReclassifyJobOptions, JSON, IO Default value is None.
@@ -3235,7 +3237,7 @@ def _cancel_job(  # pylint: disable=protected-access
 
         Submits request to cancel an existing job by Id while supplying free-form cancellation reason.
 
-        :param job_id: Id of the job. Required.
+        :param job_id: The id of the job. Required.
         :type job_id: str
         :param options: Request model for cancelling job. Is one of the following types:
          CancelJobOptions, JSON, IO Default value is None.
@@ -3315,7 +3317,8 @@ def _cancel_job(  # pylint: disable=protected-access
     def _complete_job(  # pylint: disable=protected-access
         self,
         job_id: str,
-        options: _models._models.CompleteJobOptions,
+        assignment_id: str,
+        options: Optional[_models._models.CompleteJobOptions] = None,
         *,
         content_type: str = "application/json",
         **kwargs: Any
@@ -3324,28 +3327,46 @@ def _complete_job(  # pylint: disable=protected-access
 
     @overload
     def _complete_job(  # pylint: disable=protected-access
-        self, job_id: str, options: JSON, *, content_type: str = "application/json", **kwargs: Any
+        self,
+        job_id: str,
+        assignment_id: str,
+        options: Optional[JSON] = None,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
     ) -> _models._models.CompleteJobResult:
         ...
 
     @overload
     def _complete_job(  # pylint: disable=protected-access
-        self, job_id: str, options: IO, *, content_type: str = "application/json", **kwargs: Any
+        self,
+        job_id: str,
+        assignment_id: str,
+        options: Optional[IO] = None,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
     ) -> _models._models.CompleteJobResult:
         ...
 
     @distributed_trace
     def _complete_job(  # pylint: disable=protected-access
-        self, job_id: str, options: Union[_models._models.CompleteJobOptions, JSON, IO], **kwargs: Any
+        self,
+        job_id: str,
+        assignment_id: str,
+        options: Optional[Union[_models._models.CompleteJobOptions, JSON, IO]] = None,
+        **kwargs: Any
     ) -> _models._models.CompleteJobResult:
         """Completes an assigned job.
 
         Completes an assigned job.
 
-        :param job_id: Id of the job. Required.
+        :param job_id: The id of the job. Required.
         :type job_id: str
+        :param assignment_id: The Id of the job assignment. Required.
+        :type assignment_id: str
         :param options: Request model for completing job. Is one of the following types:
-         CompleteJobOptions, JSON, IO Required.
+         CompleteJobOptions, JSON, IO Default value is None.
         :type options: ~azure.communication.jobrouter.models.CompleteJobOptions or JSON or IO
         :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default
          value is None.
@@ -3375,10 +3396,14 @@ def _complete_job(  # pylint: disable=protected-access
         if isinstance(options, (IOBase, bytes)):
             _content = options
         else:
-            _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True)  # type: ignore
+            if options is not None:
+                _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True)  # type: ignore
+            else:
+                _content = None
 
         _request = build_job_router_complete_job_request(
             job_id=job_id,
+            assignment_id=assignment_id,
             content_type=content_type,
             api_version=self._config.api_version,
             content=_content,
@@ -3419,7 +3444,8 @@ def _complete_job(  # pylint: disable=protected-access
     def _close_job(  # pylint: disable=protected-access
         self,
         job_id: str,
-        options: _models._models.CloseJobOptions,
+        assignment_id: str,
+        options: Optional[_models._models.CloseJobOptions] = None,
         *,
         content_type: str = "application/json",
         **kwargs: Any
@@ -3428,28 +3454,46 @@ def _close_job(  # pylint: disable=protected-access
 
     @overload
     def _close_job(  # pylint: disable=protected-access
-        self, job_id: str, options: JSON, *, content_type: str = "application/json", **kwargs: Any
+        self,
+        job_id: str,
+        assignment_id: str,
+        options: Optional[JSON] = None,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
     ) -> _models._models.CloseJobResult:
         ...
 
     @overload
     def _close_job(  # pylint: disable=protected-access
-        self, job_id: str, options: IO, *, content_type: str = "application/json", **kwargs: Any
+        self,
+        job_id: str,
+        assignment_id: str,
+        options: Optional[IO] = None,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
     ) -> _models._models.CloseJobResult:
         ...
 
     @distributed_trace
     def _close_job(  # pylint: disable=protected-access
-        self, job_id: str, options: Union[_models._models.CloseJobOptions, JSON, IO], **kwargs: Any
+        self,
+        job_id: str,
+        assignment_id: str,
+        options: Optional[Union[_models._models.CloseJobOptions, JSON, IO]] = None,
+        **kwargs: Any
     ) -> _models._models.CloseJobResult:
         """Closes a completed job.
 
         Closes a completed job.
 
-        :param job_id: Id of the job. Required.
+        :param job_id: The id of the job. Required.
         :type job_id: str
+        :param assignment_id: The Id of the job assignment. Required.
+        :type assignment_id: str
         :param options: Request model for closing job. Is one of the following types: CloseJobOptions,
-         JSON, IO Required.
+         JSON, IO Default value is None.
         :type options: ~azure.communication.jobrouter.models.CloseJobOptions or JSON or IO
         :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default
          value is None.
@@ -3479,10 +3523,14 @@ def _close_job(  # pylint: disable=protected-access
         if isinstance(options, (IOBase, bytes)):
             _content = options
         else:
-            _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True)  # type: ignore
+            if options is not None:
+                _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True)  # type: ignore
+            else:
+                _content = None
 
         _request = build_job_router_close_job_request(
             job_id=job_id,
+            assignment_id=assignment_id,
             content_type=content_type,
             api_version=self._config.api_version,
             content=_content,
@@ -3501,27 +3549,18 @@ def _close_job(  # pylint: disable=protected-access
 
         response = pipeline_response.http_response
 
-        if response.status_code not in [200, 202]:
+        if response.status_code not in [200]:
             if _stream:
                 response.read()  # Load the body in memory and close the socket
             map_error(status_code=response.status_code, response=response, error_map=error_map)
             raise HttpResponseError(response=response)
 
-        if response.status_code == 200:
-            if _stream:
-                deserialized = response.iter_bytes()
-            else:
-                deserialized = _deserialize(
-                    _models._models.CloseJobResult, response.json()  # pylint: disable=protected-access
-                )
-
-        if response.status_code == 202:
-            if _stream:
-                deserialized = response.iter_bytes()
-            else:
-                deserialized = _deserialize(
-                    _models._models.CloseJobResult, response.json()  # pylint: disable=protected-access
-                )
+        if _stream:
+            deserialized = response.iter_bytes()
+        else:
+            deserialized = _deserialize(
+                _models._models.CloseJobResult, response.json()  # pylint: disable=protected-access
+            )
 
         if cls:
             return cls(pipeline_response, deserialized, {})  # type: ignore
@@ -3726,9 +3765,9 @@ def unassign_job(
 
         Un-assign a job.
 
-        :param job_id: Id of the job to un-assign. Required.
+        :param job_id: The id of the job. Required.
         :type job_id: str
-        :param assignment_id: Id of the assignment to un-assign. Required.
+        :param assignment_id: The Id of the job assignment. Required.
         :type assignment_id: str
         :param options: Request body for unassign route. Default value is None.
         :type options: ~azure.communication.jobrouter.models.UnassignJobOptions
@@ -3756,9 +3795,9 @@ def unassign_job(
 
         Un-assign a job.
 
-        :param job_id: Id of the job to un-assign. Required.
+        :param job_id: The id of the job. Required.
         :type job_id: str
-        :param assignment_id: Id of the assignment to un-assign. Required.
+        :param assignment_id: The Id of the job assignment. Required.
         :type assignment_id: str
         :param options: Request body for unassign route. Default value is None.
         :type options: JSON
@@ -3786,9 +3825,9 @@ def unassign_job(
 
         Un-assign a job.
 
-        :param job_id: Id of the job to un-assign. Required.
+        :param job_id: The id of the job. Required.
         :type job_id: str
-        :param assignment_id: Id of the assignment to un-assign. Required.
+        :param assignment_id: The Id of the job assignment. Required.
         :type assignment_id: str
         :param options: Request body for unassign route. Default value is None.
         :type options: IO
@@ -3814,9 +3853,9 @@ def unassign_job(
 
         Un-assign a job.
 
-        :param job_id: Id of the job to un-assign. Required.
+        :param job_id: The id of the job. Required.
         :type job_id: str
-        :param assignment_id: Id of the assignment to un-assign. Required.
+        :param assignment_id: The Id of the job assignment. Required.
         :type assignment_id: str
         :param options: Request body for unassign route. Is one of the following types:
          UnassignJobOptions, JSON, IO Default value is None.
@@ -3901,7 +3940,7 @@ def accept_job_offer(self, worker_id: str, offer_id: str, **kwargs: Any) -> _mod
 
         :param worker_id: Id of the worker. Required.
         :type worker_id: str
-        :param offer_id: Id of the offer. Required.
+        :param offer_id: The Id of the offer. Required.
         :type offer_id: str
         :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You
          will have to context manage the returned stream.
@@ -4007,7 +4046,7 @@ def _decline_job_offer(  # pylint: disable=protected-access
 
         :param worker_id: Id of the worker. Required.
         :type worker_id: str
-        :param offer_id: Id of the offer. Required.
+        :param offer_id: The Id of the offer. Required.
         :type offer_id: str
         :param options: Request model for declining offer. Is one of the following types:
          DeclineJobOfferOptions, JSON, IO Default value is None.