Azure/azure-sdk-for-python azure-communication-jobrouter_1.0.0

on GitHub

1.0.0 (2023-11-01)

Features Added

• JobRouterAdministrationClient
  • Add upsert_distribution_policy. Supports match_condition: Optional[MatchConditions] which can specify HTTP options for conditional requests based on etag: Optional[str] and/or if_unmodified_since: Optional[~datetime.datetime].
  • Add upsert_queue. Supports match_condition: Optional[MatchConditions] which can specify HTTP options for conditional requests based on etag: Optional[str] and/or if_unmodified_since: Optional[~datetime.datetime].
  • Add upsert_classification_policy. Supports match_condition: Optional[MatchConditions] which can specify HTTP options for conditional requests based on etag: Optional[str] and/or if_unmodified_since: Optional[~datetime.datetime].
  • Add upsert_exception_policy. Supports match_condition: Optional[MatchConditions] which can specify HTTP options for conditional requests based on etag: Optional[str] and/or if_unmodified_since: Optional[~datetime.datetime].
• JobRouterClient
  • Add upsert_job. Supports match_condition: Optional[MatchConditions] which can specify HTTP options for conditional requests based on etag: Optional[str] and/or if_unmodified_since: Optional[~datetime.datetime].
  • Add upsert_worker. Supports match_condition: Optional[MatchConditions] which can specify HTTP options for conditional requests based on etag: Optional[str] and/or if_unmodified_since: Optional[~datetime.datetime].

Breaking Changes

• All models now resides under azure.communication.jobrouter.models instead of azure.communication.jobrouter.
• JobRouterAdministrationClient
  • Create and update methods have been removed for DistributionPolicy. Use upsert_distribution_policy instead.
  • Create and update methods have been removed for RouterQueue. Use upsert_queue instead.
  • Create and update methods have been removed for ClassificationPolicy. Use upsert_classification_policy instead.
  • Create and update methods have been removed for ExceptionPolicy. Use upsert_exception_policy instead.
  • list_classification_policies returns (Async)Iterable[ClassificationPolicy] instead of (Async)Iterable[ClassificationPolicyItem]
  • list_distribution_policies returns (Async)Iterable[DistributionPolicy] instead of (Async)Iterable[DistributionPolicyItem]
  • list_exception_policies returns (Async)Iterable[ExceptionPolicy] instead of (Async)Iterable[ExceptionPolicyItem]
  • list_queues returns (Async)Iterable[RouterQueue] instead of (Async)Iterable[RouterQueueItem]
• JobRouterClient
  • Create and update methods have been removed for RouterJob. Use upsert_job instead.
  • 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 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
  • Rename property queue_selectors to queue_selector_attachments.
  • Rename property worker_selectors to worker_selector_attachments.
• ExceptionPolicy
  • Property exception_rules - Changed from Dictionary[str, ExceptionRule] -> List[ExceptionRule]
• ExceptionRule
  • Property actions - Changed Dict[str, ExceptionAction] -> List[ExceptionAction]
• ScoringRuleOptions
  • Rename property allow_scoring_batch_of_workers -> is_batch_scoring_enabled
• RouterWorker
  • 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
• JobMatchingMode
  • Property kind - Changed from str to JobMatchingModeKind
  • Affected derived classes: QueueAndMatchMode, ScheduleAndSuspendMode, SuspendMode
• RouterRule
  • Property kind - Changed from str to RouterRuleKind
  • Affected derived classes: DirectMapRouterRule, ExpressionRouterRule, FunctionRouterRule, StaticRouterRule, WebhookRouterRule
• DistributionMode
  • Property kind - Changed from str to DistributionModeKind
  • Affected derived classes: RoundRobinMode, LongestIdleMode, BestWorkerMode
• ExceptionTrigger
  • Property kind - Changed from str to ExceptionTriggerKind
  • Affected derived classes: QueueLengthExceptionTrigger, WaitTimeExceptionTrigger
• ExceptionAction
  • Property kind - Changed from str to ExceptionActionKind
  • Affected derived classes: CancelExceptionAction, ManualReclassifyExceptionAction, ReclassifyExceptionAction
• QueueSelectorAttachment
  • Property kind - Changed from str to QueueSelectorAttachmentKind
  • Affected derived classes: ConditionalQueueSelectorAttachment, PassThroughQueueSelectorAttachment, RuleEngineQueueSelectorAttachment, StaticQueueSelectorAttachment, WeightedAllocationQueueSelectorAttachment
• WorkerSelectorAttachment
  • Property kind - Changed from str to WorkerSelectorAttachmentKind
  • Affected derived classes: ConditionalWorkerSelectorAttachment, PassThroughWorkerSelectorAttachment, RuleEngineWorkerSelectorAttachment, StaticWorkerSelectorAttachment, WeightedAllocationWorkerSelectorAttachment

Renames

• ChannelConfiguration -> RouterChannel
• Oauth2ClientCredential -> OAuth2WebhookClientCredential

Deletions

• ClassificationPolicyItem
• DistributionPolicyItem
• ExceptionPolicyItem
• RouterQueueItem
• RouterWorkerItem
• RouterJobItem
• RouterQueueAssignment

Other Changes

• ClassificationPolicy
  • Add etag
• DistributionPolicy
  • Add etag
• ExceptionPolicy
  • Add etag
• RouterQueue
  • Add etag
• RouterJob
  • Add etag
• RouterWorker
  • Add etag
• ExceptionRule
  • Add id
• ExceptionAction and all derived classes CancelExceptionAction, ManualReclassifyExceptionAction, ReclassifyExceptionAction
  • Add id. If not provided, it will be generated by the service.
• RouterChannel
  • Add channel_id