Release History
1.1.0b2 (Unreleased)
Features Added
Breaking Changes
Bugs Fixed
Other Changes
1.1.0b1 (2024-04-12)
This is the beta release of Azure Communication Job Router Python SDK. For more information, please see the README.
This is a Public Preview version, so breaking changes are possible in subsequent releases as we improve the product. To provide feedback, please submit an issue in our Azure SDK for Python GitHub repo.
Features Added
JobRouterClient
upsert_worker
- keyword argument
max_concurrent_offers: Optional[int]
added.
- keyword argument
RouterWorker
- Add
max_concurrent_offers
- Add
1.0.0 (2023-11-01)
Features Added
JobRouterAdministrationClient
- Add
upsert_distribution_policy
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. - Add
upsert_queue
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. - Add
upsert_classification_policy
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. - Add
upsert_exception_policy
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
.
- Add
JobRouterClient
- Add
upsert_job
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. - Add
upsert_worker
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
.
- Add
Breaking Changes
- All models now resides under
azure.communication.jobrouter.models
instead ofazure.communication.jobrouter
. JobRouterAdministrationClient
- Create and update methods have been removed for
DistributionPolicy
. Useupsert_distribution_policy
instead. - Create and update methods have been removed for
RouterQueue
. Useupsert_queue
instead. - Create and update methods have been removed for
ClassificationPolicy
. Useupsert_classification_policy
instead. - Create and update methods have been removed for
ExceptionPolicy
. Useupsert_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]
- Create and update methods have been removed for
JobRouterClient
- Create and update methods have been removed for
RouterJob
. Useupsert_job
instead. - Create and update methods have been removed for
RouterWorker
. Useupsert_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 argumentretry_offer_at: Optional[datetime]
removed from method. Useoptions: Optional[Union[DeclineJobOfferOptions, JSON, IO]]
instead.close_job
- keyword arguments
close_at: Optional[datetime]
,disposition_code: Optional[str]
,note: Optional[str]
removed from method. Useoptions: Optional[Union[CloseJobOptions, JSON, IO]]
instead. assignment_id: str
added as positional argument.
- keyword arguments
cancel_job
- keyword argumentsdisposition_code: Optional[str]
,note: Optional[str]
removed from method. Useoptions: Optional[Union[CancelJobOptions, JSON, IO]]
instead.complete_job
- keyword argument
note: Optional[str]
removed from method. Useoptions: Optional[Union[CompleteJobOptions, JSON, IO]]
instead. assignment_id: str
added as positional argument.
- keyword argument
unassign_job
- keyword argumentsuspend_matching: Optional[bool]
removed from method. Useoptions: Optional[Union[UnassignJobOptions, JSON, IO]]
instead.
- Create and update methods have been removed for
RouterJob
- Property
notes
- Changed fromDict[str, ~datetime.datetime]
toList[RouterJobNote]
- Property
ClassificationPolicy
- Rename property
queue_selectors
toqueue_selector_attachments
. - Rename property
worker_selectors
toworker_selector_attachments
.
- Rename property
ExceptionPolicy
- Property
exception_rules
- Changed fromDictionary[str, ExceptionRule]
->List[ExceptionRule]
- Property
ExceptionRule
- Property
actions
- ChangedDict[str, ExceptionAction]
->List[ExceptionAction]
- Property
ScoringRuleOptions
- Rename property
allow_scoring_batch_of_workers
->is_batch_scoring_enabled
- Rename property
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]
- Property changed
CloseJobOptions
- Removed property
assignment_id
- Removed property
CompleteJobOptions
- Removed property
assignment_id
- Removed property
JobMatchingMode
- Property
kind
- Changed fromstr
toJobMatchingModeKind
- Affected derived classes:
QueueAndMatchMode
,ScheduleAndSuspendMode
,SuspendMode
- Property
RouterRule
- Property
kind
- Changed fromstr
toRouterRuleKind
- Affected derived classes:
DirectMapRouterRule
,ExpressionRouterRule
,FunctionRouterRule
,StaticRouterRule
,WebhookRouterRule
- Property
DistributionMode
- Property
kind
- Changed fromstr
toDistributionModeKind
- Affected derived classes:
RoundRobinMode
,LongestIdleMode
,BestWorkerMode
- Property
ExceptionTrigger
- Property
kind
- Changed fromstr
toExceptionTriggerKind
- Affected derived classes:
QueueLengthExceptionTrigger
,WaitTimeExceptionTrigger
- Property
ExceptionAction
- Property
kind
- Changed fromstr
toExceptionActionKind
- Affected derived classes:
CancelExceptionAction
,ManualReclassifyExceptionAction
,ReclassifyExceptionAction
- Property
QueueSelectorAttachment
- Property
kind
- Changed fromstr
toQueueSelectorAttachmentKind
- Affected derived classes:
ConditionalQueueSelectorAttachment
,PassThroughQueueSelectorAttachment
,RuleEngineQueueSelectorAttachment
,StaticQueueSelectorAttachment
,WeightedAllocationQueueSelectorAttachment
- Property
WorkerSelectorAttachment
- Property
kind
- Changed fromstr
toWorkerSelectorAttachmentKind
- Affected derived classes:
ConditionalWorkerSelectorAttachment
,PassThroughWorkerSelectorAttachment
,RuleEngineWorkerSelectorAttachment
,StaticWorkerSelectorAttachment
,WeightedAllocationWorkerSelectorAttachment
- Property
Renames
ChannelConfiguration
->RouterChannel
Oauth2ClientCredential
->OAuth2WebhookClientCredential
Deletions
ClassificationPolicyItem
DistributionPolicyItem
ExceptionPolicyItem
RouterQueueItem
RouterWorkerItem
RouterJobItem
RouterQueueAssignment
Other Changes
ClassificationPolicy
- Add
etag
- Add
DistributionPolicy
- Add
etag
- Add
ExceptionPolicy
- Add
etag
- Add
RouterQueue
- Add
etag
- Add
RouterJob
- Add
etag
- Add
RouterWorker
- Add
etag
- Add
ExceptionRule
- Add
id
- Add
ExceptionAction
and all derived classesCancelExceptionAction
,ManualReclassifyExceptionAction
,ReclassifyExceptionAction
- Add
id
. If not provided, it will be generated by the service.
- Add
RouterChannel
- Add
channel_id
- Add
1.0.0b1 (2023-07-27)
This is the beta release of Azure Communication Job Router Python SDK. For more information, please see the README.
This is a Public Preview version, so breaking changes are possible in subsequent releases as we improve the product. To provide feedback, please submit an issue in our Azure SDK for Python GitHub repo.
Features Added
- Using
JobRouterAdministrationClient
- Create, update, get, list and delete
DistributionPolicy
. - Create, update, get, list and delete
RouterQueue
. - Create, update, get, list and delete
ClassificationPolicy
. - Create, update, get, list and delete
ExceptionPolicy
.
- Create, update, get, list and delete
- Using
JobRouterClient
- Create, update, get, list and delete
RouterJob
. RouterJob
can be created and updated with different matching modes:QueueAndMatchMode
,ScheduleAndSuspendMode
andSuspendMode
.- Re-classify a
RouterJob
. - Close a
RouterJob
. - Complete a
RouterJob
. - Cancel a
RouterJob
. - Un-assign a
RouterJob
, with option to suspend matching. - Get the position of a
RouterJob
in a queue. - Create, update, get, list and delete
RouterWorker
. - Accept an offer.
- Decline an offer.
- Get queue statistics.
- Create, update, get, list and delete