1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Taskrouter
This is the public Twilio REST API.
NOTE: This class is auto generated by OpenAPI Generator.
https://openapi-generator.tech
Do not edit the class manually.
"""
from datetime import datetime
from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator
from twilio.base import deserialize, serialize, values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
from twilio.base.page import Page
from twilio.rest.taskrouter.v1.workspace.task.reservation import ReservationList
class TaskInstance(InstanceResource):
class Status(object):
PENDING = "pending"
RESERVED = "reserved"
ASSIGNED = "assigned"
CANCELED = "canceled"
COMPLETED = "completed"
WRAPPING = "wrapping"
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Task resource.
:ivar age: The number of seconds since the Task was created.
:ivar assignment_status:
:ivar attributes: The JSON string with custom attributes of the work. **Note** If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null.
:ivar addons: An object that contains the [Add-on](https://www.twilio.com/docs/add-ons) data for all installed Add-ons.
:ivar date_created: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar date_updated: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar task_queue_entered_date: The date and time in GMT when the Task entered the TaskQueue, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar priority: The current priority score of the Task as assigned to a Worker by the workflow. Tasks with higher priority values will be assigned before Tasks with lower values.
:ivar reason: The reason the Task was canceled or completed, if applicable.
:ivar sid: The unique string that we created to identify the Task resource.
:ivar task_queue_sid: The SID of the TaskQueue.
:ivar task_queue_friendly_name: The friendly name of the TaskQueue.
:ivar task_channel_sid: The SID of the TaskChannel.
:ivar task_channel_unique_name: The unique name of the TaskChannel.
:ivar timeout: The amount of time in seconds that the Task can live before being assigned.
:ivar workflow_sid: The SID of the Workflow that is controlling the Task.
:ivar workflow_friendly_name: The friendly name of the Workflow that is controlling the Task.
:ivar workspace_sid: The SID of the Workspace that contains the Task.
:ivar url: The absolute URL of the Task resource.
:ivar links: The URLs of related resources.
:ivar virtual_start_time: The date and time in GMT indicating the ordering for routing of the Task specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar ignore_capacity: A boolean that indicates if the Task should respect a Worker's capacity and availability during assignment. This field can only be used when the `RoutingTarget` field is set to a Worker SID. By setting `IgnoreCapacity` to a value of `true`, `1`, or `yes`, the Task will be routed to the Worker without respecting their capacity and availability. Any other value will enforce the Worker's capacity and availability. The default value of `IgnoreCapacity` is `true` when the `RoutingTarget` is set to a Worker SID.
:ivar routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
workspace_sid: str,
sid: Optional[str] = None,
):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.age: Optional[int] = deserialize.integer(payload.get("age"))
self.assignment_status: Optional["TaskInstance.Status"] = payload.get(
"assignment_status"
)
self.attributes: Optional[str] = payload.get("attributes")
self.addons: Optional[str] = payload.get("addons")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_updated")
)
self.task_queue_entered_date: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("task_queue_entered_date")
)
self.priority: Optional[int] = deserialize.integer(payload.get("priority"))
self.reason: Optional[str] = payload.get("reason")
self.sid: Optional[str] = payload.get("sid")
self.task_queue_sid: Optional[str] = payload.get("task_queue_sid")
self.task_queue_friendly_name: Optional[str] = payload.get(
"task_queue_friendly_name"
)
self.task_channel_sid: Optional[str] = payload.get("task_channel_sid")
self.task_channel_unique_name: Optional[str] = payload.get(
"task_channel_unique_name"
)
self.timeout: Optional[int] = deserialize.integer(payload.get("timeout"))
self.workflow_sid: Optional[str] = payload.get("workflow_sid")
self.workflow_friendly_name: Optional[str] = payload.get(
"workflow_friendly_name"
)
self.workspace_sid: Optional[str] = payload.get("workspace_sid")
self.url: Optional[str] = payload.get("url")
self.links: Optional[Dict[str, object]] = payload.get("links")
self.virtual_start_time: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("virtual_start_time")
)
self.ignore_capacity: Optional[bool] = payload.get("ignore_capacity")
self.routing_target: Optional[str] = payload.get("routing_target")
self._solution = {
"workspace_sid": workspace_sid,
"sid": sid or self.sid,
}
self._context: Optional[TaskContext] = None
@property
def _proxy(self) -> "TaskContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: TaskContext for this TaskInstance
"""
if self._context is None:
self._context = TaskContext(
self._version,
workspace_sid=self._solution["workspace_sid"],
sid=self._solution["sid"],
)
return self._context
def delete(self, if_match: Union[str, object] = values.unset) -> bool:
"""
Deletes the TaskInstance
:param if_match: If provided, deletes this Task if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete(
if_match=if_match,
)
async def delete_async(self, if_match: Union[str, object] = values.unset) -> bool:
"""
Asynchronous coroutine that deletes the TaskInstance
:param if_match: If provided, deletes this Task if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async(
if_match=if_match,
)
def fetch(self) -> "TaskInstance":
"""
Fetch the TaskInstance
:returns: The fetched TaskInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "TaskInstance":
"""
Asynchronous coroutine to fetch the TaskInstance
:returns: The fetched TaskInstance
"""
return await self._proxy.fetch_async()
def update(
self,
if_match: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
assignment_status: Union["TaskInstance.Status", object] = values.unset,
reason: Union[str, object] = values.unset,
priority: Union[int, object] = values.unset,
task_channel: Union[str, object] = values.unset,
virtual_start_time: Union[datetime, object] = values.unset,
) -> "TaskInstance":
"""
Update the TaskInstance
:param if_match: If provided, applies this mutation if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:param attributes: The JSON string that describes the custom attributes of the task.
:param assignment_status:
:param reason: The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
:param priority: The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).
:param task_channel: When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:param virtual_start_time: The task's new virtual start time value. When supplied, the Task takes on the specified virtual start time. Value can't be in the future or before the year of 1900.
:returns: The updated TaskInstance
"""
return self._proxy.update(
if_match=if_match,
attributes=attributes,
assignment_status=assignment_status,
reason=reason,
priority=priority,
task_channel=task_channel,
virtual_start_time=virtual_start_time,
)
async def update_async(
self,
if_match: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
assignment_status: Union["TaskInstance.Status", object] = values.unset,
reason: Union[str, object] = values.unset,
priority: Union[int, object] = values.unset,
task_channel: Union[str, object] = values.unset,
virtual_start_time: Union[datetime, object] = values.unset,
) -> "TaskInstance":
"""
Asynchronous coroutine to update the TaskInstance
:param if_match: If provided, applies this mutation if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:param attributes: The JSON string that describes the custom attributes of the task.
:param assignment_status:
:param reason: The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
:param priority: The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).
:param task_channel: When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:param virtual_start_time: The task's new virtual start time value. When supplied, the Task takes on the specified virtual start time. Value can't be in the future or before the year of 1900.
:returns: The updated TaskInstance
"""
return await self._proxy.update_async(
if_match=if_match,
attributes=attributes,
assignment_status=assignment_status,
reason=reason,
priority=priority,
task_channel=task_channel,
virtual_start_time=virtual_start_time,
)
@property
def reservations(self) -> ReservationList:
"""
Access the reservations
"""
return self._proxy.reservations
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Taskrouter.V1.TaskInstance {}>".format(context)
class TaskContext(InstanceContext):
def __init__(self, version: Version, workspace_sid: str, sid: str):
"""
Initialize the TaskContext
:param version: Version that contains the resource
:param workspace_sid: The SID of the Workspace with the Task to update.
:param sid: The SID of the Task resource to update.
"""
super().__init__(version)
# Path Solution
self._solution = {
"workspace_sid": workspace_sid,
"sid": sid,
}
self._uri = "/Workspaces/{workspace_sid}/Tasks/{sid}".format(**self._solution)
self._reservations: Optional[ReservationList] = None
def delete(self, if_match: Union[str, object] = values.unset) -> bool:
"""
Deletes the TaskInstance
:param if_match: If provided, deletes this Task if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:returns: True if delete succeeds, False otherwise
"""
headers = values.of(
{
"If-Match": if_match,
}
)
headers = values.of({})
return self._version.delete(method="DELETE", uri=self._uri, headers=headers)
async def delete_async(self, if_match: Union[str, object] = values.unset) -> bool:
"""
Asynchronous coroutine that deletes the TaskInstance
:param if_match: If provided, deletes this Task if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:returns: True if delete succeeds, False otherwise
"""
headers = values.of(
{
"If-Match": if_match,
}
)
headers = values.of({})
return await self._version.delete_async(
method="DELETE", uri=self._uri, headers=headers
)
def fetch(self) -> TaskInstance:
"""
Fetch the TaskInstance
:returns: The fetched TaskInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return TaskInstance(
self._version,
payload,
workspace_sid=self._solution["workspace_sid"],
sid=self._solution["sid"],
)
async def fetch_async(self) -> TaskInstance:
"""
Asynchronous coroutine to fetch the TaskInstance
:returns: The fetched TaskInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return TaskInstance(
self._version,
payload,
workspace_sid=self._solution["workspace_sid"],
sid=self._solution["sid"],
)
def update(
self,
if_match: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
assignment_status: Union["TaskInstance.Status", object] = values.unset,
reason: Union[str, object] = values.unset,
priority: Union[int, object] = values.unset,
task_channel: Union[str, object] = values.unset,
virtual_start_time: Union[datetime, object] = values.unset,
) -> TaskInstance:
"""
Update the TaskInstance
:param if_match: If provided, applies this mutation if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:param attributes: The JSON string that describes the custom attributes of the task.
:param assignment_status:
:param reason: The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
:param priority: The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).
:param task_channel: When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:param virtual_start_time: The task's new virtual start time value. When supplied, the Task takes on the specified virtual start time. Value can't be in the future or before the year of 1900.
:returns: The updated TaskInstance
"""
data = values.of(
{
"Attributes": attributes,
"AssignmentStatus": assignment_status,
"Reason": reason,
"Priority": priority,
"TaskChannel": task_channel,
"VirtualStartTime": serialize.iso8601_datetime(virtual_start_time),
}
)
headers = values.of({})
if not (
if_match is values.unset or (isinstance(if_match, str) and not if_match)
):
headers["If-Match"] = if_match
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.update(
method="POST", uri=self._uri, data=data, headers=headers
)
return TaskInstance(
self._version,
payload,
workspace_sid=self._solution["workspace_sid"],
sid=self._solution["sid"],
)
async def update_async(
self,
if_match: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
assignment_status: Union["TaskInstance.Status", object] = values.unset,
reason: Union[str, object] = values.unset,
priority: Union[int, object] = values.unset,
task_channel: Union[str, object] = values.unset,
virtual_start_time: Union[datetime, object] = values.unset,
) -> TaskInstance:
"""
Asynchronous coroutine to update the TaskInstance
:param if_match: If provided, applies this mutation if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:param attributes: The JSON string that describes the custom attributes of the task.
:param assignment_status:
:param reason: The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
:param priority: The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).
:param task_channel: When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:param virtual_start_time: The task's new virtual start time value. When supplied, the Task takes on the specified virtual start time. Value can't be in the future or before the year of 1900.
:returns: The updated TaskInstance
"""
data = values.of(
{
"Attributes": attributes,
"AssignmentStatus": assignment_status,
"Reason": reason,
"Priority": priority,
"TaskChannel": task_channel,
"VirtualStartTime": serialize.iso8601_datetime(virtual_start_time),
}
)
headers = values.of({})
if not (
if_match is values.unset or (isinstance(if_match, str) and not if_match)
):
headers["If-Match"] = if_match
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.update_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return TaskInstance(
self._version,
payload,
workspace_sid=self._solution["workspace_sid"],
sid=self._solution["sid"],
)
@property
def reservations(self) -> ReservationList:
"""
Access the reservations
"""
if self._reservations is None:
self._reservations = ReservationList(
self._version,
self._solution["workspace_sid"],
self._solution["sid"],
)
return self._reservations
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Taskrouter.V1.TaskContext {}>".format(context)
class TaskPage(Page):
def get_instance(self, payload: Dict[str, Any]) -> TaskInstance:
"""
Build an instance of TaskInstance
:param payload: Payload response from the API
"""
return TaskInstance(
self._version, payload, workspace_sid=self._solution["workspace_sid"]
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Taskrouter.V1.TaskPage>"
class TaskList(ListResource):
def __init__(self, version: Version, workspace_sid: str):
"""
Initialize the TaskList
:param version: Version that contains the resource
:param workspace_sid: The SID of the Workspace with the Tasks to read.
"""
super().__init__(version)
# Path Solution
self._solution = {
"workspace_sid": workspace_sid,
}
self._uri = "/Workspaces/{workspace_sid}/Tasks".format(**self._solution)
def create(
self,
timeout: Union[int, object] = values.unset,
priority: Union[int, object] = values.unset,
task_channel: Union[str, object] = values.unset,
workflow_sid: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
virtual_start_time: Union[datetime, object] = values.unset,
routing_target: Union[str, object] = values.unset,
ignore_capacity: Union[str, object] = values.unset,
task_queue_sid: Union[str, object] = values.unset,
) -> TaskInstance:
"""
Create the TaskInstance
:param timeout: The amount of time in seconds the new task can live before being assigned. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value is 24 hours (86,400 seconds). On timeout, the `task.canceled` event will fire with description `Task TTL Exceeded`.
:param priority: The priority to assign the new task and override the default. When supplied, the new Task will have this priority unless it matches a Workflow Target with a Priority set. When not supplied, the new Task will have the priority of the matching Workflow Target. Value can be 0 to 2^31^ (2,147,483,647).
:param task_channel: When MultiTasking is enabled, specify the TaskChannel by passing either its `unique_name` or `sid`. Default value is `default`.
:param workflow_sid: The SID of the Workflow that you would like to handle routing for the new Task. If there is only one Workflow defined for the Workspace that you are posting the new task to, this parameter is optional.
:param attributes: A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ \\\"task_type\\\": \\\"call\\\", \\\"twilio_call_sid\\\": \\\"CAxxx\\\", \\\"customer_ticket_number\\\": \\\"12345\\\" }`.
:param virtual_start_time: The virtual start time to assign the new task and override the default. When supplied, the new task will have this virtual start time. When not supplied, the new task will have the virtual start time equal to `date_created`. Value can't be in the future or before the year of 1900.
:param routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
:param ignore_capacity: A boolean that indicates if the Task should respect a Worker's capacity and availability during assignment. This field can only be used when the `RoutingTarget` field is set to a Worker SID. By setting `IgnoreCapacity` to a value of `true`, `1`, or `yes`, the Task will be routed to the Worker without respecting their capacity and availability. Any other value will enforce the Worker's capacity and availability. The default value of `IgnoreCapacity` is `true` when the `RoutingTarget` is set to a Worker SID.
:param task_queue_sid: The SID of the TaskQueue in which the Task belongs
:returns: The created TaskInstance
"""
data = values.of(
{
"Timeout": timeout,
"Priority": priority,
"TaskChannel": task_channel,
"WorkflowSid": workflow_sid,
"Attributes": attributes,
"VirtualStartTime": serialize.iso8601_datetime(virtual_start_time),
"RoutingTarget": routing_target,
"IgnoreCapacity": ignore_capacity,
"TaskQueueSid": task_queue_sid,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.create(
method="POST", uri=self._uri, data=data, headers=headers
)
return TaskInstance(
self._version, payload, workspace_sid=self._solution["workspace_sid"]
)
async def create_async(
self,
timeout: Union[int, object] = values.unset,
priority: Union[int, object] = values.unset,
task_channel: Union[str, object] = values.unset,
workflow_sid: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
virtual_start_time: Union[datetime, object] = values.unset,
routing_target: Union[str, object] = values.unset,
ignore_capacity: Union[str, object] = values.unset,
task_queue_sid: Union[str, object] = values.unset,
) -> TaskInstance:
"""
Asynchronously create the TaskInstance
:param timeout: The amount of time in seconds the new task can live before being assigned. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value is 24 hours (86,400 seconds). On timeout, the `task.canceled` event will fire with description `Task TTL Exceeded`.
:param priority: The priority to assign the new task and override the default. When supplied, the new Task will have this priority unless it matches a Workflow Target with a Priority set. When not supplied, the new Task will have the priority of the matching Workflow Target. Value can be 0 to 2^31^ (2,147,483,647).
:param task_channel: When MultiTasking is enabled, specify the TaskChannel by passing either its `unique_name` or `sid`. Default value is `default`.
:param workflow_sid: The SID of the Workflow that you would like to handle routing for the new Task. If there is only one Workflow defined for the Workspace that you are posting the new task to, this parameter is optional.
:param attributes: A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ \\\"task_type\\\": \\\"call\\\", \\\"twilio_call_sid\\\": \\\"CAxxx\\\", \\\"customer_ticket_number\\\": \\\"12345\\\" }`.
:param virtual_start_time: The virtual start time to assign the new task and override the default. When supplied, the new task will have this virtual start time. When not supplied, the new task will have the virtual start time equal to `date_created`. Value can't be in the future or before the year of 1900.
:param routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
:param ignore_capacity: A boolean that indicates if the Task should respect a Worker's capacity and availability during assignment. This field can only be used when the `RoutingTarget` field is set to a Worker SID. By setting `IgnoreCapacity` to a value of `true`, `1`, or `yes`, the Task will be routed to the Worker without respecting their capacity and availability. Any other value will enforce the Worker's capacity and availability. The default value of `IgnoreCapacity` is `true` when the `RoutingTarget` is set to a Worker SID.
:param task_queue_sid: The SID of the TaskQueue in which the Task belongs
:returns: The created TaskInstance
"""
data = values.of(
{
"Timeout": timeout,
"Priority": priority,
"TaskChannel": task_channel,
"WorkflowSid": workflow_sid,
"Attributes": attributes,
"VirtualStartTime": serialize.iso8601_datetime(virtual_start_time),
"RoutingTarget": routing_target,
"IgnoreCapacity": ignore_capacity,
"TaskQueueSid": task_queue_sid,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.create_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return TaskInstance(
self._version, payload, workspace_sid=self._solution["workspace_sid"]
)
def stream(
self,
priority: Union[int, object] = values.unset,
assignment_status: Union[List[str], object] = values.unset,
workflow_sid: Union[str, object] = values.unset,
workflow_name: Union[str, object] = values.unset,
task_queue_sid: Union[str, object] = values.unset,
task_queue_name: Union[str, object] = values.unset,
evaluate_task_attributes: Union[str, object] = values.unset,
routing_target: Union[str, object] = values.unset,
ordering: Union[str, object] = values.unset,
has_addons: Union[bool, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[TaskInstance]:
"""
Streams TaskInstance records from the API as a generator stream.
This operation lazily loads records as efficiently as possible until the limit
is reached.
The results are returned as a generator, so this operation is memory efficient.
:param int priority: The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.
:param List[str] assignment_status: The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.
:param str workflow_sid: The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.
:param str workflow_name: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.
:param str task_queue_sid: The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
:param str task_queue_name: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
:param str evaluate_task_attributes: The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
:param str routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
:param str ordering: How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
:param bool has_addons: Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.
:param limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the
limit with the most efficient page size, i.e. min(limit, 1000)
:returns: Generator that will yield up to limit results
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(
priority=priority,
assignment_status=assignment_status,
workflow_sid=workflow_sid,
workflow_name=workflow_name,
task_queue_sid=task_queue_sid,
task_queue_name=task_queue_name,
evaluate_task_attributes=evaluate_task_attributes,
routing_target=routing_target,
ordering=ordering,
has_addons=has_addons,
page_size=limits["page_size"],
)
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
priority: Union[int, object] = values.unset,
assignment_status: Union[List[str], object] = values.unset,
workflow_sid: Union[str, object] = values.unset,
workflow_name: Union[str, object] = values.unset,
task_queue_sid: Union[str, object] = values.unset,
task_queue_name: Union[str, object] = values.unset,
evaluate_task_attributes: Union[str, object] = values.unset,
routing_target: Union[str, object] = values.unset,
ordering: Union[str, object] = values.unset,
has_addons: Union[bool, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> AsyncIterator[TaskInstance]:
"""
Asynchronously streams TaskInstance records from the API as a generator stream.
This operation lazily loads records as efficiently as possible until the limit
is reached.
The results are returned as a generator, so this operation is memory efficient.
:param int priority: The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.
:param List[str] assignment_status: The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.
:param str workflow_sid: The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.
:param str workflow_name: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.
:param str task_queue_sid: The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
:param str task_queue_name: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
:param str evaluate_task_attributes: The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
:param str routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
:param str ordering: How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
:param bool has_addons: Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.
:param limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the
limit with the most efficient page size, i.e. min(limit, 1000)
:returns: Generator that will yield up to limit results
"""
limits = self._version.read_limits(limit, page_size)
page = await self.page_async(
priority=priority,
assignment_status=assignment_status,
workflow_sid=workflow_sid,
workflow_name=workflow_name,
task_queue_sid=task_queue_sid,
task_queue_name=task_queue_name,
evaluate_task_attributes=evaluate_task_attributes,
routing_target=routing_target,
ordering=ordering,
has_addons=has_addons,
page_size=limits["page_size"],
)
return self._version.stream_async(page, limits["limit"])
def list(
self,
priority: Union[int, object] = values.unset,
assignment_status: Union[List[str], object] = values.unset,
workflow_sid: Union[str, object] = values.unset,
workflow_name: Union[str, object] = values.unset,
task_queue_sid: Union[str, object] = values.unset,
task_queue_name: Union[str, object] = values.unset,
evaluate_task_attributes: Union[str, object] = values.unset,
routing_target: Union[str, object] = values.unset,
ordering: Union[str, object] = values.unset,
has_addons: Union[bool, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[TaskInstance]:
"""
Lists TaskInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param int priority: The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.
:param List[str] assignment_status: The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.
:param str workflow_sid: The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.
:param str workflow_name: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.
:param str task_queue_sid: The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
:param str task_queue_name: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
:param str evaluate_task_attributes: The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
:param str routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
:param str ordering: How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
:param bool has_addons: Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.
:param limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, list() will attempt to read the limit
with the most efficient page size, i.e. min(limit, 1000)
:returns: list that will contain up to limit results
"""
return list(
self.stream(
priority=priority,
assignment_status=assignment_status,
workflow_sid=workflow_sid,
workflow_name=workflow_name,
task_queue_sid=task_queue_sid,
task_queue_name=task_queue_name,
evaluate_task_attributes=evaluate_task_attributes,
routing_target=routing_target,
ordering=ordering,
has_addons=has_addons,
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
priority: Union[int, object] = values.unset,
assignment_status: Union[List[str], object] = values.unset,
workflow_sid: Union[str, object] = values.unset,
workflow_name: Union[str, object] = values.unset,
task_queue_sid: Union[str, object] = values.unset,
task_queue_name: Union[str, object] = values.unset,
evaluate_task_attributes: Union[str, object] = values.unset,
routing_target: Union[str, object] = values.unset,
ordering: Union[str, object] = values.unset,
has_addons: Union[bool, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[TaskInstance]:
"""
Asynchronously lists TaskInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param int priority: The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.
:param List[str] assignment_status: The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.
:param str workflow_sid: The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.
:param str workflow_name: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.
:param str task_queue_sid: The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
:param str task_queue_name: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
:param str evaluate_task_attributes: The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
:param str routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
:param str ordering: How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
:param bool has_addons: Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.
:param limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, list() will attempt to read the limit
with the most efficient page size, i.e. min(limit, 1000)
:returns: list that will contain up to limit results
"""
return [
record
async for record in await self.stream_async(
priority=priority,
assignment_status=assignment_status,
workflow_sid=workflow_sid,
workflow_name=workflow_name,
task_queue_sid=task_queue_sid,
task_queue_name=task_queue_name,
evaluate_task_attributes=evaluate_task_attributes,
routing_target=routing_target,
ordering=ordering,
has_addons=has_addons,
limit=limit,
page_size=page_size,
)
]
def page(
self,
priority: Union[int, object] = values.unset,
assignment_status: Union[List[str], object] = values.unset,
workflow_sid: Union[str, object] = values.unset,
workflow_name: Union[str, object] = values.unset,
task_queue_sid: Union[str, object] = values.unset,
task_queue_name: Union[str, object] = values.unset,
evaluate_task_attributes: Union[str, object] = values.unset,
routing_target: Union[str, object] = values.unset,
ordering: Union[str, object] = values.unset,
has_addons: Union[bool, object] = values.unset,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> TaskPage:
"""
Retrieve a single page of TaskInstance records from the API.
Request is executed immediately
:param priority: The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.
:param assignment_status: The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.
:param workflow_sid: The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.
:param workflow_name: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.
:param task_queue_sid: The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
:param task_queue_name: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
:param evaluate_task_attributes: The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
:param routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
:param ordering: How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
:param has_addons: Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.
:param page_token: PageToken provided by the API
:param page_number: Page Number, this value is simply for client state
:param page_size: Number of records to return, defaults to 50
:returns: Page of TaskInstance
"""
data = values.of(
{
"Priority": priority,
"AssignmentStatus": serialize.map(assignment_status, lambda e: e),
"WorkflowSid": workflow_sid,
"WorkflowName": workflow_name,
"TaskQueueSid": task_queue_sid,
"TaskQueueName": task_queue_name,
"EvaluateTaskAttributes": evaluate_task_attributes,
"RoutingTarget": routing_target,
"Ordering": ordering,
"HasAddons": serialize.boolean_to_string(has_addons),
"PageToken": page_token,
"Page": page_number,
"PageSize": page_size,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Accept"] = "application/json"
response = self._version.page(
method="GET", uri=self._uri, params=data, headers=headers
)
return TaskPage(self._version, response, self._solution)
async def page_async(
self,
priority: Union[int, object] = values.unset,
assignment_status: Union[List[str], object] = values.unset,
workflow_sid: Union[str, object] = values.unset,
workflow_name: Union[str, object] = values.unset,
task_queue_sid: Union[str, object] = values.unset,
task_queue_name: Union[str, object] = values.unset,
evaluate_task_attributes: Union[str, object] = values.unset,
routing_target: Union[str, object] = values.unset,
ordering: Union[str, object] = values.unset,
has_addons: Union[bool, object] = values.unset,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> TaskPage:
"""
Asynchronously retrieve a single page of TaskInstance records from the API.
Request is executed immediately
:param priority: The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.
:param assignment_status: The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.
:param workflow_sid: The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.
:param workflow_name: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.
:param task_queue_sid: The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
:param task_queue_name: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
:param evaluate_task_attributes: The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
:param routing_target: A SID of a Worker, Queue, or Workflow to route a Task to
:param ordering: How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
:param has_addons: Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.
:param page_token: PageToken provided by the API
:param page_number: Page Number, this value is simply for client state
:param page_size: Number of records to return, defaults to 50
:returns: Page of TaskInstance
"""
data = values.of(
{
"Priority": priority,
"AssignmentStatus": serialize.map(assignment_status, lambda e: e),
"WorkflowSid": workflow_sid,
"WorkflowName": workflow_name,
"TaskQueueSid": task_queue_sid,
"TaskQueueName": task_queue_name,
"EvaluateTaskAttributes": evaluate_task_attributes,
"RoutingTarget": routing_target,
"Ordering": ordering,
"HasAddons": serialize.boolean_to_string(has_addons),
"PageToken": page_token,
"Page": page_number,
"PageSize": page_size,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Accept"] = "application/json"
response = await self._version.page_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return TaskPage(self._version, response, self._solution)
def get_page(self, target_url: str) -> TaskPage:
"""
Retrieve a specific page of TaskInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of TaskInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return TaskPage(self._version, response, self._solution)
async def get_page_async(self, target_url: str) -> TaskPage:
"""
Asynchronously retrieve a specific page of TaskInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of TaskInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return TaskPage(self._version, response, self._solution)
def get(self, sid: str) -> TaskContext:
"""
Constructs a TaskContext
:param sid: The SID of the Task resource to update.
"""
return TaskContext(
self._version, workspace_sid=self._solution["workspace_sid"], sid=sid
)
def __call__(self, sid: str) -> TaskContext:
"""
Constructs a TaskContext
:param sid: The SID of the Task resource to update.
"""
return TaskContext(
self._version, workspace_sid=self._solution["workspace_sid"], sid=sid
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Taskrouter.V1.TaskList>"
|