Spaces:
Build error
Build error
File size: 81,651 Bytes
0827183 |
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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 |
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
from typing import List
from msrest.serialization import Model
from botbuilder.schema import (
Attachment,
ChannelAccount,
PagedMembersResult,
ConversationAccount,
)
class TabEntityContext(Model):
"""
Current TabRequest entity context, or 'tabEntityId'.
:param tab_entity_id: Gets or sets the entity id of the tab.
:type tab_entity_id: str
"""
_attribute_map = {
"tab_entity_id": {"key": "tabEntityId", "type": "str"},
}
def __init__(self, *, tab_entity_id=None, **kwargs) -> None:
super(TabEntityContext, self).__init__(**kwargs)
self.tab_entity_id = tab_entity_id
self._custom_init()
def _custom_init(self):
return
class TaskModuleRequest(Model):
"""Task module invoke request value payload.
:param data: User input data. Free payload with key-value pairs.
:type data: object
:param context: Current user context, i.e., the current theme
:type context:
~botframework.connector.teams.models.TaskModuleRequestContext
:param tab_entity_context: Gets or sets current tab request context.
:type tab_entity_context:
~botframework.connector.teams.models.TabEntityContext
"""
_attribute_map = {
"data": {"key": "data", "type": "object"},
"context": {"key": "context", "type": "TaskModuleRequestContext"},
"tab_entity_context": {"key": "tabContext", "type": "TabEntityContext"},
}
def __init__(
self, *, data=None, context=None, tab_entity_context=None, **kwargs
) -> None:
super(TaskModuleRequest, self).__init__(**kwargs)
self.data = data
self.context = context
self.tab_entity_context = tab_entity_context
class AppBasedLinkQuery(Model):
"""Invoke request body type for app-based link query.
:param url: Url queried by user
:type url: str
:param state: The magic code for OAuth Flow
:type state: str
"""
_attribute_map = {
"url": {"key": "url", "type": "str"},
"state": {"key": "state", "type": "str"},
}
def __init__(self, *, url: str = None, state: str = None, **kwargs) -> None:
super(AppBasedLinkQuery, self).__init__(**kwargs)
self.url = url
self.state = state
class ChannelInfo(Model):
"""A channel info object which describes the channel.
:param id: Unique identifier representing a channel
:type id: str
:param name: Name of the channel
:type name: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
}
def __init__(self, *, id: str = None, name: str = None, **kwargs) -> None:
super(ChannelInfo, self).__init__(**kwargs)
self.id = id
self.name = name
class CacheInfo(Model):
"""A cache info object which notifies Teams how long an object should be cached for.
:param cache_type: Type of Cache Info
:type cache_type: str
:param cache_duration: Duration of the Cached Info.
:type cache_duration: int
"""
_attribute_map = {
"cache_type": {"key": "cacheType", "type": "str"},
"cache_duration": {"key": "cacheDuration", "type": "int"},
}
def __init__(
self, *, cache_type: str = None, cache_duration: int = None, **kwargs
) -> None:
super(CacheInfo, self).__init__(**kwargs)
self.cache_type = cache_type
self.cache_duration = cache_duration
class ConversationList(Model):
"""List of channels under a team.
:param conversations:
:type conversations:
list[~botframework.connector.teams.models.ChannelInfo]
"""
_attribute_map = {
"conversations": {"key": "conversations", "type": "[ChannelInfo]"},
}
def __init__(self, *, conversations=None, **kwargs) -> None:
super(ConversationList, self).__init__(**kwargs)
self.conversations = conversations
class FileConsentCard(Model):
"""File consent card attachment.
:param description: File description.
:type description: str
:param size_in_bytes: Size of the file to be uploaded in Bytes.
:type size_in_bytes: long
:param accept_context: Context sent back to the Bot if user consented to
upload. This is free flow schema and is sent back in Value field of
Activity.
:type accept_context: object
:param decline_context: Context sent back to the Bot if user declined.
This is free flow schema and is sent back in Value field of Activity.
:type decline_context: object
"""
_attribute_map = {
"description": {"key": "description", "type": "str"},
"size_in_bytes": {"key": "sizeInBytes", "type": "long"},
"accept_context": {"key": "acceptContext", "type": "object"},
"decline_context": {"key": "declineContext", "type": "object"},
}
def __init__(
self,
*,
description: str = None,
size_in_bytes: int = None,
accept_context=None,
decline_context=None,
**kwargs
) -> None:
super(FileConsentCard, self).__init__(**kwargs)
self.description = description
self.size_in_bytes = size_in_bytes
self.accept_context = accept_context
self.decline_context = decline_context
class FileConsentCardResponse(Model):
"""Represents the value of the invoke activity sent when the user acts on a
file consent card.
:param action: The action the user took. Possible values include:
'accept', 'decline'
:type action: str
:param context: The context associated with the action.
:type context: object
:param upload_info: If the user accepted the file, contains information
about the file to be uploaded.
:type upload_info: ~botframework.connector.teams.models.FileUploadInfo
"""
_attribute_map = {
"action": {"key": "action", "type": "str"},
"context": {"key": "context", "type": "object"},
"upload_info": {"key": "uploadInfo", "type": "FileUploadInfo"},
}
def __init__(
self, *, action=None, context=None, upload_info=None, **kwargs
) -> None:
super(FileConsentCardResponse, self).__init__(**kwargs)
self.action = action
self.context = context
self.upload_info = upload_info
class FileDownloadInfo(Model):
"""File download info attachment.
:param download_url: File download url.
:type download_url: str
:param unique_id: Unique Id for the file.
:type unique_id: str
:param file_type: Type of file.
:type file_type: str
:param etag: ETag for the file.
:type etag: object
"""
_attribute_map = {
"download_url": {"key": "downloadUrl", "type": "str"},
"unique_id": {"key": "uniqueId", "type": "str"},
"file_type": {"key": "fileType", "type": "str"},
"etag": {"key": "etag", "type": "object"},
}
def __init__(
self,
*,
download_url: str = None,
unique_id: str = None,
file_type: str = None,
etag=None,
**kwargs
) -> None:
super(FileDownloadInfo, self).__init__(**kwargs)
self.download_url = download_url
self.unique_id = unique_id
self.file_type = file_type
self.etag = etag
class FileInfoCard(Model):
"""File info card.
:param unique_id: Unique Id for the file.
:type unique_id: str
:param file_type: Type of file.
:type file_type: str
:param etag: ETag for the file.
:type etag: object
"""
_attribute_map = {
"unique_id": {"key": "uniqueId", "type": "str"},
"file_type": {"key": "fileType", "type": "str"},
"etag": {"key": "etag", "type": "object"},
}
def __init__(
self, *, unique_id: str = None, file_type: str = None, etag=None, **kwargs
) -> None:
super(FileInfoCard, self).__init__(**kwargs)
self.unique_id = unique_id
self.file_type = file_type
self.etag = etag
class FileUploadInfo(Model):
"""Information about the file to be uploaded.
:param name: Name of the file.
:type name: str
:param upload_url: URL to an upload session that the bot can use to set
the file contents.
:type upload_url: str
:param content_url: URL to file.
:type content_url: str
:param unique_id: ID that uniquely identifies the file.
:type unique_id: str
:param file_type: Type of the file.
:type file_type: str
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"upload_url": {"key": "uploadUrl", "type": "str"},
"content_url": {"key": "contentUrl", "type": "str"},
"unique_id": {"key": "uniqueId", "type": "str"},
"file_type": {"key": "fileType", "type": "str"},
}
def __init__(
self,
*,
name: str = None,
upload_url: str = None,
content_url: str = None,
unique_id: str = None,
file_type: str = None,
**kwargs
) -> None:
super(FileUploadInfo, self).__init__(**kwargs)
self.name = name
self.upload_url = upload_url
self.content_url = content_url
self.unique_id = unique_id
self.file_type = file_type
class MessageActionsPayloadApp(Model):
"""Represents an application entity.
:param application_identity_type: The type of application. Possible values
include: 'aadApplication', 'bot', 'tenantBot', 'office365Connector',
'webhook'
:type application_identity_type: str or
~botframework.connector.teams.models.enum
:param id: The id of the application.
:type id: str
:param display_name: The plaintext display name of the application.
:type display_name: str
"""
_attribute_map = {
"application_identity_type": {"key": "applicationIdentityType", "type": "str"},
"id": {"key": "id", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
}
def __init__(
self,
*,
application_identity_type=None,
id: str = None,
display_name: str = None,
**kwargs
) -> None:
super(MessageActionsPayloadApp, self).__init__(**kwargs)
self.application_identity_type = application_identity_type
self.id = id
self.display_name = display_name
class MessageActionsPayloadAttachment(Model):
"""Represents the attachment in a message.
:param id: The id of the attachment.
:type id: str
:param content_type: The type of the attachment.
:type content_type: str
:param content_url: The url of the attachment, in case of a external link.
:type content_url: str
:param content: The content of the attachment, in case of a code snippet,
email, or file.
:type content: object
:param name: The plaintext display name of the attachment.
:type name: str
:param thumbnail_url: The url of a thumbnail image that might be embedded
in the attachment, in case of a card.
:type thumbnail_url: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"content_type": {"key": "contentType", "type": "str"},
"content_url": {"key": "contentUrl", "type": "str"},
"content": {"key": "content", "type": "object"},
"name": {"key": "name", "type": "str"},
"thumbnail_url": {"key": "thumbnailUrl", "type": "str"},
}
def __init__(
self,
*,
id: str = None,
content_type: str = None,
content_url: str = None,
content=None,
name: str = None,
thumbnail_url: str = None,
**kwargs
) -> None:
super(MessageActionsPayloadAttachment, self).__init__(**kwargs)
self.id = id
self.content_type = content_type
self.content_url = content_url
self.content = content
self.name = name
self.thumbnail_url = thumbnail_url
class MessageActionsPayloadBody(Model):
"""Plaintext/HTML representation of the content of the message.
:param content_type: Type of the content. Possible values include: 'html',
'text'
:type content_type: str
:param content: The content of the body.
:type content: str
"""
_attribute_map = {
"content_type": {"key": "contentType", "type": "str"},
"content": {"key": "content", "type": "str"},
}
def __init__(self, *, content_type=None, content: str = None, **kwargs) -> None:
super(MessageActionsPayloadBody, self).__init__(**kwargs)
self.content_type = content_type
self.content = content
class MessageActionsPayloadConversation(Model):
"""Represents a team or channel entity.
:param conversation_identity_type: The type of conversation, whether a
team or channel. Possible values include: 'team', 'channel'
:type conversation_identity_type: str or
~botframework.connector.teams.models.enum
:param id: The id of the team or channel.
:type id: str
:param display_name: The plaintext display name of the team or channel
entity.
:type display_name: str
"""
_attribute_map = {
"conversation_identity_type": {
"key": "conversationIdentityType",
"type": "str",
},
"id": {"key": "id", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
}
def __init__(
self,
*,
conversation_identity_type=None,
id: str = None,
display_name: str = None,
**kwargs
) -> None:
super(MessageActionsPayloadConversation, self).__init__(**kwargs)
self.conversation_identity_type = conversation_identity_type
self.id = id
self.display_name = display_name
class MessageActionsPayloadFrom(Model):
"""Represents a user, application, or conversation type that either sent or
was referenced in a message.
:param user: Represents details of the user.
:type user: ~botframework.connector.teams.models.MessageActionsPayloadUser
:param application: Represents details of the app.
:type application:
~botframework.connector.teams.models.MessageActionsPayloadApp
:param conversation: Represents details of the converesation.
:type conversation:
~botframework.connector.teams.models.MessageActionsPayloadConversation
"""
_attribute_map = {
"user": {"key": "user", "type": "MessageActionsPayloadUser"},
"application": {"key": "application", "type": "MessageActionsPayloadApp"},
"conversation": {
"key": "conversation",
"type": "MessageActionsPayloadConversation",
},
}
def __init__(
self, *, user=None, application=None, conversation=None, **kwargs
) -> None:
super(MessageActionsPayloadFrom, self).__init__(**kwargs)
self.user = user
self.application = application
self.conversation = conversation
class MessageActionsPayloadMention(Model):
"""Represents the entity that was mentioned in the message.
:param id: The id of the mentioned entity.
:type id: int
:param mention_text: The plaintext display name of the mentioned entity.
:type mention_text: str
:param mentioned: Provides more details on the mentioned entity.
:type mentioned:
~botframework.connector.teams.models.MessageActionsPayloadFrom
"""
_attribute_map = {
"id": {"key": "id", "type": "int"},
"mention_text": {"key": "mentionText", "type": "str"},
"mentioned": {"key": "mentioned", "type": "MessageActionsPayloadFrom"},
}
def __init__(
self, *, id: int = None, mention_text: str = None, mentioned=None, **kwargs
) -> None:
super(MessageActionsPayloadMention, self).__init__(**kwargs)
self.id = id
self.mention_text = mention_text
self.mentioned = mentioned
class MessageActionsPayloadReaction(Model):
"""Represents the reaction of a user to a message.
:param reaction_type: The type of reaction given to the message. Possible
values include: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry'
:type reaction_type: str
:param created_date_time: Timestamp of when the user reacted to the
message.
:type created_date_time: str
:param user: The user with which the reaction is associated.
:type user: ~botframework.connector.teams.models.MessageActionsPayloadFrom
"""
_attribute_map = {
"reaction_type": {"key": "reactionType", "type": "str"},
"created_date_time": {"key": "createdDateTime", "type": "str"},
"user": {"key": "user", "type": "MessageActionsPayloadFrom"},
}
def __init__(
self, *, reaction_type=None, created_date_time: str = None, user=None, **kwargs
) -> None:
super(MessageActionsPayloadReaction, self).__init__(**kwargs)
self.reaction_type = reaction_type
self.created_date_time = created_date_time
self.user = user
class MessageActionsPayloadUser(Model):
"""Represents a user entity.
:param user_identity_type: The identity type of the user. Possible values
include: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', 'federatedUser'
:type user_identity_type: str
:param id: The id of the user.
:type id: str
:param display_name: The plaintext display name of the user.
:type display_name: str
"""
_attribute_map = {
"user_identity_type": {"key": "userIdentityType", "type": "str"},
"id": {"key": "id", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
}
def __init__(
self,
*,
user_identity_type=None,
id: str = None,
display_name: str = None,
**kwargs
) -> None:
super(MessageActionsPayloadUser, self).__init__(**kwargs)
self.user_identity_type = user_identity_type
self.id = id
self.display_name = display_name
class MessageActionsPayload(Model):
"""Represents the individual message within a chat or channel where a message
actions is taken.
:param id: Unique id of the message.
:type id: str
:param reply_to_id: Id of the parent/root message of the thread.
:type reply_to_id: str
:param message_type: Type of message - automatically set to message.
Possible values include: 'message'
:type message_type: str
:param created_date_time: Timestamp of when the message was created.
:type created_date_time: str
:param last_modified_date_time: Timestamp of when the message was edited
or updated.
:type last_modified_date_time: str
:param deleted: Indicates whether a message has been soft deleted.
:type deleted: bool
:param subject: Subject line of the message.
:type subject: str
:param summary: Summary text of the message that could be used for
notifications.
:type summary: str
:param importance: The importance of the message. Possible values include:
'normal', 'high', 'urgent'
:type importance: str
:param locale: Locale of the message set by the client.
:type locale: str
:param link_to_message: Link back to the message.
:type link_to_message: str
:param from_property: Sender of the message.
:type from_property:
~botframework.connector.teams.models.MessageActionsPayloadFrom
:param body: Plaintext/HTML representation of the content of the message.
:type body: ~botframework.connector.teams.models.MessageActionsPayloadBody
:param attachment_layout: How the attachment(s) are displayed in the
message.
:type attachment_layout: str
:param attachments: Attachments in the message - card, image, file, etc.
:type attachments:
list[~botframework.connector.teams.models.MessageActionsPayloadAttachment]
:param mentions: List of entities mentioned in the message.
:type mentions:
list[~botframework.connector.teams.models.MessageActionsPayloadMention]
:param reactions: Reactions for the message.
:type reactions:
list[~botframework.connector.teams.models.MessageActionsPayloadReaction]
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"reply_to_id": {"key": "replyToId", "type": "str"},
"message_type": {"key": "messageType", "type": "str"},
"created_date_time": {"key": "createdDateTime", "type": "str"},
"last_modified_date_time": {"key": "lastModifiedDateTime", "type": "str"},
"deleted": {"key": "deleted", "type": "bool"},
"subject": {"key": "subject", "type": "str"},
"summary": {"key": "summary", "type": "str"},
"importance": {"key": "importance", "type": "str"},
"locale": {"key": "locale", "type": "str"},
"link_to_message": {"key": "linkToMessage", "type": "str"},
"from_property": {"key": "from", "type": "MessageActionsPayloadFrom"},
"body": {"key": "body", "type": "MessageActionsPayloadBody"},
"attachment_layout": {"key": "attachmentLayout", "type": "str"},
"attachments": {
"key": "attachments",
"type": "[MessageActionsPayloadAttachment]",
},
"mentions": {"key": "mentions", "type": "[MessageActionsPayloadMention]"},
"reactions": {"key": "reactions", "type": "[MessageActionsPayloadReaction]"},
}
def __init__(
self,
*,
id: str = None,
reply_to_id: str = None,
message_type=None,
created_date_time: str = None,
last_modified_date_time: str = None,
deleted: bool = None,
subject: str = None,
summary: str = None,
importance=None,
locale: str = None,
link_to_message: str = None,
from_property=None,
body=None,
attachment_layout: str = None,
attachments=None,
mentions=None,
reactions=None,
**kwargs
) -> None:
super(MessageActionsPayload, self).__init__(**kwargs)
self.id = id
self.reply_to_id = reply_to_id
self.message_type = message_type
self.created_date_time = created_date_time
self.last_modified_date_time = last_modified_date_time
self.deleted = deleted
self.subject = subject
self.summary = summary
self.importance = importance
self.locale = locale
self.link_to_message = link_to_message
self.from_property = from_property
self.body = body
self.attachment_layout = attachment_layout
self.attachments = attachments
self.mentions = mentions
self.reactions = reactions
class MessagingExtensionAction(TaskModuleRequest):
"""Messaging extension action.
:param data: User input data. Free payload with key-value pairs.
:type data: object
:param context: Current user context, i.e., the current theme
:type context:
~botframework.connector.teams.models.TaskModuleRequestContext
:param command_id: Id of the command assigned by Bot
:type command_id: str
:param command_context: The context from which the command originates.
Possible values include: 'message', 'compose', 'commandbox'
:type command_context: str
:param bot_message_preview_action: Bot message preview action taken by
user. Possible values include: 'edit', 'send'
:type bot_message_preview_action: str or
~botframework.connector.teams.models.enum
:param bot_activity_preview:
:type bot_activity_preview:
list[~botframework.schema.models.Activity]
:param message_payload: Message content sent as part of the command
request.
:type message_payload:
~botframework.connector.teams.models.MessageActionsPayload
"""
_attribute_map = {
"data": {"key": "data", "type": "object"},
"context": {"key": "context", "type": "TaskModuleRequestContext"},
"command_id": {"key": "commandId", "type": "str"},
"command_context": {"key": "commandContext", "type": "str"},
"bot_message_preview_action": {"key": "botMessagePreviewAction", "type": "str"},
"bot_activity_preview": {"key": "botActivityPreview", "type": "[Activity]"},
"message_payload": {"key": "messagePayload", "type": "MessageActionsPayload"},
}
def __init__(
self,
*,
data=None,
context=None,
command_id: str = None,
command_context=None,
bot_message_preview_action=None,
bot_activity_preview=None,
message_payload=None,
**kwargs
) -> None:
super(MessagingExtensionAction, self).__init__(
data=data, context=context, **kwargs
)
self.command_id = command_id
self.command_context = command_context
self.bot_message_preview_action = bot_message_preview_action
self.bot_activity_preview = bot_activity_preview
self.message_payload = message_payload
class MessagingExtensionActionResponse(Model):
"""Response of messaging extension action.
:param task: The JSON for the Adaptive card to appear in the task module.
:type task: ~botframework.connector.teams.models.TaskModuleResponseBase
:param compose_extension:
:type compose_extension:
~botframework.connector.teams.models.MessagingExtensionResult
:param cache_info: CacheInfo for this MessagingExtensionActionResponse.
:type cache_info: ~botframework.connector.teams.models.CacheInfo
"""
_attribute_map = {
"task": {"key": "task", "type": "TaskModuleResponseBase"},
"compose_extension": {
"key": "composeExtension",
"type": "MessagingExtensionResult",
},
"cache_info": {"key": "cacheInfo", "type": "CacheInfo"},
}
def __init__(
self,
*,
task=None,
compose_extension=None,
cache_info: CacheInfo = None,
**kwargs
) -> None:
super(MessagingExtensionActionResponse, self).__init__(**kwargs)
self.task = task
self.compose_extension = compose_extension
self.cache_info = cache_info
class MessagingExtensionAttachment(Attachment):
"""Messaging extension attachment.
:param content_type: mimetype/Contenttype for the file
:type content_type: str
:param content_url: Content Url
:type content_url: str
:param content: Embedded content
:type content: object
:param name: (OPTIONAL) The name of the attachment
:type name: str
:param thumbnail_url: (OPTIONAL) Thumbnail associated with attachment
:type thumbnail_url: str
:param preview:
:type preview: ~botframework.connector.teams.models.Attachment
"""
_attribute_map = {
"content_type": {"key": "contentType", "type": "str"},
"content_url": {"key": "contentUrl", "type": "str"},
"content": {"key": "content", "type": "object"},
"name": {"key": "name", "type": "str"},
"thumbnail_url": {"key": "thumbnailUrl", "type": "str"},
"preview": {"key": "preview", "type": "Attachment"},
}
def __init__(
self,
*,
content_type: str = None,
content_url: str = None,
content=None,
name: str = None,
thumbnail_url: str = None,
preview=None,
**kwargs
) -> None:
super(MessagingExtensionAttachment, self).__init__(
content_type=content_type,
content_url=content_url,
content=content,
name=name,
thumbnail_url=thumbnail_url,
**kwargs
)
self.preview = preview
class MessagingExtensionParameter(Model):
"""Messaging extension query parameters.
:param name: Name of the parameter
:type name: str
:param value: Value of the parameter
:type value: object
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"value": {"key": "value", "type": "object"},
}
def __init__(self, *, name: str = None, value=None, **kwargs) -> None:
super(MessagingExtensionParameter, self).__init__(**kwargs)
self.name = name
self.value = value
class MessagingExtensionQuery(Model):
"""Messaging extension query.
:param command_id: Id of the command assigned by Bot
:type command_id: str
:param parameters: Parameters for the query
:type parameters:
list[~botframework.connector.teams.models.MessagingExtensionParameter]
:param query_options:
:type query_options:
~botframework.connector.teams.models.MessagingExtensionQueryOptions
:param state: State parameter passed back to the bot after
authentication/configuration flow
:type state: str
"""
_attribute_map = {
"command_id": {"key": "commandId", "type": "str"},
"parameters": {"key": "parameters", "type": "[MessagingExtensionParameter]"},
"query_options": {
"key": "queryOptions",
"type": "MessagingExtensionQueryOptions",
},
"state": {"key": "state", "type": "str"},
}
def __init__(
self,
*,
command_id: str = None,
parameters=None,
query_options=None,
state: str = None,
**kwargs
) -> None:
super(MessagingExtensionQuery, self).__init__(**kwargs)
self.command_id = command_id
self.parameters = parameters
self.query_options = query_options
self.state = state
class MessagingExtensionQueryOptions(Model):
"""Messaging extension query options.
:param skip: Number of entities to skip
:type skip: int
:param count: Number of entities to fetch
:type count: int
"""
_attribute_map = {
"skip": {"key": "skip", "type": "int"},
"count": {"key": "count", "type": "int"},
}
def __init__(self, *, skip: int = None, count: int = None, **kwargs) -> None:
super(MessagingExtensionQueryOptions, self).__init__(**kwargs)
self.skip = skip
self.count = count
class MessagingExtensionResponse(Model):
"""Messaging extension response.
:param compose_extension:
:type compose_extension: ~botframework.connector.teams.models.MessagingExtensionResult
:param cache_info: CacheInfo for this MessagingExtensionResponse.
:type cache_info: ~botframework.connector.teams.models.CacheInfo
"""
_attribute_map = {
"compose_extension": {
"key": "composeExtension",
"type": "MessagingExtensionResult",
},
"cache_info": {"key": "cacheInfo", "type": CacheInfo},
}
def __init__(self, *, compose_extension=None, cache_info=None, **kwargs) -> None:
super(MessagingExtensionResponse, self).__init__(**kwargs)
self.compose_extension = compose_extension
self.cache_info = cache_info
class MessagingExtensionResult(Model):
"""Messaging extension result.
:param attachment_layout: Hint for how to deal with multiple attachments.
Possible values include: 'list', 'grid'
:type attachment_layout: str
:param type: The type of the result. Possible values include: 'result',
'auth', 'config', 'message', 'botMessagePreview'
:type type: str
:param attachments: (Only when type is result) Attachments
:type attachments:
list[~botframework.connector.teams.models.MessagingExtensionAttachment]
:param suggested_actions:
:type suggested_actions:
~botframework.connector.teams.models.MessagingExtensionSuggestedAction
:param text: (Only when type is message) Text
:type text: str
:param activity_preview: (Only when type is botMessagePreview) Message
activity to preview
:type activity_preview: ~botframework.connector.teams.models.Activity
"""
_attribute_map = {
"attachment_layout": {"key": "attachmentLayout", "type": "str"},
"type": {"key": "type", "type": "str"},
"attachments": {"key": "attachments", "type": "[MessagingExtensionAttachment]"},
"suggested_actions": {
"key": "suggestedActions",
"type": "MessagingExtensionSuggestedAction",
},
"text": {"key": "text", "type": "str"},
"activity_preview": {"key": "activityPreview", "type": "Activity"},
}
def __init__(
self,
*,
attachment_layout=None,
type=None,
attachments=None,
suggested_actions=None,
text: str = None,
activity_preview=None,
**kwargs
) -> None:
super(MessagingExtensionResult, self).__init__(**kwargs)
self.attachment_layout = attachment_layout
self.type = type
self.attachments = attachments
self.suggested_actions = suggested_actions
self.text = text
self.activity_preview = activity_preview
class MessagingExtensionSuggestedAction(Model):
"""Messaging extension Actions (Only when type is auth or config).
:param actions: Actions
:type actions: list[~botframework.connector.teams.models.CardAction]
"""
_attribute_map = {
"actions": {"key": "actions", "type": "[CardAction]"},
}
def __init__(self, *, actions=None, **kwargs) -> None:
super(MessagingExtensionSuggestedAction, self).__init__(**kwargs)
self.actions = actions
class NotificationInfo(Model):
"""Specifies if a notification is to be sent for the mentions.
:param alert: true if notification is to be sent to the user, false
otherwise.
:type alert: bool
"""
_attribute_map = {
"alert": {"key": "alert", "type": "bool"},
"alert_in_meeting": {"key": "alertInMeeting", "type": "bool"},
"external_resource_url": {"key": "externalResourceUrl", "type": "str"},
}
def __init__(
self,
*,
alert: bool = None,
alert_in_meeting: bool = None,
external_resource_url: str = None,
**kwargs
) -> None:
super(NotificationInfo, self).__init__(**kwargs)
self.alert = alert
self.alert_in_meeting = alert_in_meeting
self.external_resource_url = external_resource_url
class O365ConnectorCard(Model):
"""O365 connector card.
:param title: Title of the item
:type title: str
:param text: Text for the card
:type text: str
:param summary: Summary for the card
:type summary: str
:param theme_color: Theme color for the card
:type theme_color: str
:param sections: Set of sections for the current card
:type sections:
list[~botframework.connector.teams.models.O365ConnectorCardSection]
:param potential_action: Set of actions for the current card
:type potential_action:
list[~botframework.connector.teams.models.O365ConnectorCardActionBase]
"""
_attribute_map = {
"title": {"key": "title", "type": "str"},
"text": {"key": "text", "type": "str"},
"summary": {"key": "summary", "type": "str"},
"theme_color": {"key": "themeColor", "type": "str"},
"sections": {"key": "sections", "type": "[O365ConnectorCardSection]"},
"potential_action": {
"key": "potentialAction",
"type": "[O365ConnectorCardActionBase]",
},
}
def __init__(
self,
*,
title: str = None,
text: str = None,
summary: str = None,
theme_color: str = None,
sections=None,
potential_action=None,
**kwargs
) -> None:
super(O365ConnectorCard, self).__init__(**kwargs)
self.title = title
self.text = text
self.summary = summary
self.theme_color = theme_color
self.sections = sections
self.potential_action = potential_action
class O365ConnectorCardInputBase(Model):
"""O365 connector card input for ActionCard action.
:param type: Input type name. Possible values include: 'textInput',
'dateInput', 'multichoiceInput'
:type type: str
:param id: Input Id. It must be unique per entire O365 connector card.
:type id: str
:param is_required: Define if this input is a required field. Default
value is false.
:type is_required: bool
:param title: Input title that will be shown as the placeholder
:type title: str
:param value: Default value for this input field
:type value: str
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"id": {"key": "id", "type": "str"},
"is_required": {"key": "isRequired", "type": "bool"},
"title": {"key": "title", "type": "str"},
"value": {"key": "value", "type": "str"},
}
def __init__(
self,
*,
type=None,
id: str = None,
is_required: bool = None,
title: str = None,
value: str = None,
**kwargs
) -> None:
super(O365ConnectorCardInputBase, self).__init__(**kwargs)
self.type = type
self.id = id
self.is_required = is_required
self.title = title
self.value = value
class O365ConnectorCardActionBase(Model):
"""O365 connector card action base.
:param type: Type of the action. Possible values include: 'ViewAction',
'OpenUri', 'HttpPOST', 'ActionCard'
:type type: str
:param name: Name of the action that will be used as button title
:type name: str
:param id: Action Id
:type id: str
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"name": {"key": "name", "type": "str"},
"id": {"key": "@id", "type": "str"},
}
def __init__(
self, *, type=None, name: str = None, id: str = None, **kwargs
) -> None:
super(O365ConnectorCardActionBase, self).__init__(**kwargs)
self.type = type
self.name = name
self.id = id
class O365ConnectorCardActionCard(O365ConnectorCardActionBase):
"""O365 connector card ActionCard action.
:param type: Type of the action. Possible values include: 'ViewAction',
'OpenUri', 'HttpPOST', 'ActionCard'
:type type: str
:param name: Name of the action that will be used as button title
:type name: str
:param id: Action Id
:type id: str
:param inputs: Set of inputs contained in this ActionCard whose each item
can be in any subtype of O365ConnectorCardInputBase
:type inputs:
list[~botframework.connector.teams.models.O365ConnectorCardInputBase]
:param actions: Set of actions contained in this ActionCard whose each
item can be in any subtype of O365ConnectorCardActionBase except
O365ConnectorCardActionCard, as nested ActionCard is forbidden.
:type actions:
list[~botframework.connector.teams.models.O365ConnectorCardActionBase]
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"name": {"key": "name", "type": "str"},
"id": {"key": "@id", "type": "str"},
"inputs": {"key": "inputs", "type": "[O365ConnectorCardInputBase]"},
"actions": {"key": "actions", "type": "[O365ConnectorCardActionBase]"},
}
def __init__(
self,
*,
type=None,
name: str = None,
id: str = None,
inputs=None,
actions=None,
**kwargs
) -> None:
super(O365ConnectorCardActionCard, self).__init__(
type=type, name=name, id=id, **kwargs
)
self.inputs = inputs
self.actions = actions
class O365ConnectorCardActionQuery(Model):
"""O365 connector card HttpPOST invoke query.
:param body: The results of body string defined in
IO365ConnectorCardHttpPOST with substituted input values
:type body: str
:param action_id: Action Id associated with the HttpPOST action button
triggered, defined in O365ConnectorCardActionBase.
:type action_id: str
"""
_attribute_map = {
"body": {"key": "body", "type": "str"},
"action_id": {"key": "actionId", "type": "str"},
}
def __init__(self, *, body: str = None, actionId: str = None, **kwargs) -> None:
super(O365ConnectorCardActionQuery, self).__init__(**kwargs)
self.body = body
# This is how it comes in from Teams
self.action_id = actionId
class O365ConnectorCardDateInput(O365ConnectorCardInputBase):
"""O365 connector card date input.
:param type: Input type name. Possible values include: 'textInput',
'dateInput', 'multichoiceInput'
:type type: str
:param id: Input Id. It must be unique per entire O365 connector card.
:type id: str
:param is_required: Define if this input is a required field. Default
value is false.
:type is_required: bool
:param title: Input title that will be shown as the placeholder
:type title: str
:param value: Default value for this input field
:type value: str
:param include_time: Include time input field. Default value is false
(date only).
:type include_time: bool
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"id": {"key": "id", "type": "str"},
"is_required": {"key": "isRequired", "type": "bool"},
"title": {"key": "title", "type": "str"},
"value": {"key": "value", "type": "str"},
"include_time": {"key": "includeTime", "type": "bool"},
}
def __init__(
self,
*,
type=None,
id: str = None,
is_required: bool = None,
title: str = None,
value: str = None,
include_time: bool = None,
**kwargs
) -> None:
super(O365ConnectorCardDateInput, self).__init__(
type=type,
id=id,
is_required=is_required,
title=title,
value=value,
**kwargs
)
self.include_time = include_time
class O365ConnectorCardFact(Model):
"""O365 connector card fact.
:param name: Display name of the fact
:type name: str
:param value: Display value for the fact
:type value: str
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"value": {"key": "value", "type": "str"},
}
def __init__(self, *, name: str = None, value: str = None, **kwargs) -> None:
super(O365ConnectorCardFact, self).__init__(**kwargs)
self.name = name
self.value = value
class O365ConnectorCardHttpPOST(O365ConnectorCardActionBase):
"""O365 connector card HttpPOST action.
:param type: Type of the action. Possible values include: 'ViewAction',
'OpenUri', 'HttpPOST', 'ActionCard'
:type type: str
:param name: Name of the action that will be used as button title
:type name: str
:param id: Action Id
:type id: str
:param body: Content to be posted back to bots via invoke
:type body: str
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"name": {"key": "name", "type": "str"},
"id": {"key": "@id", "type": "str"},
"body": {"key": "body", "type": "str"},
}
def __init__(
self, *, type=None, name: str = None, id: str = None, body: str = None, **kwargs
) -> None:
super(O365ConnectorCardHttpPOST, self).__init__(
type=type, name=name, id=id, **kwargs
)
self.body = body
class O365ConnectorCardImage(Model):
"""O365 connector card image.
:param image: URL for the image
:type image: str
:param title: Alternative text for the image
:type title: str
"""
_attribute_map = {
"image": {"key": "image", "type": "str"},
"title": {"key": "title", "type": "str"},
}
def __init__(self, *, image: str = None, title: str = None, **kwargs) -> None:
super(O365ConnectorCardImage, self).__init__(**kwargs)
self.image = image
self.title = title
class O365ConnectorCardMultichoiceInput(O365ConnectorCardInputBase):
"""O365 connector card multiple choice input.
:param type: Input type name. Possible values include: 'textInput',
'dateInput', 'multichoiceInput'
:type type: str
:param id: Input Id. It must be unique per entire O365 connector card.
:type id: str
:param is_required: Define if this input is a required field. Default
value is false.
:type is_required: bool
:param title: Input title that will be shown as the placeholder
:type title: str
:param value: Default value for this input field
:type value: str
:param choices: Set of choices whose each item can be in any subtype of
O365ConnectorCardMultichoiceInputChoice.
:type choices:
list[~botframework.connector.teams.models.O365ConnectorCardMultichoiceInputChoice]
:param style: Choice item rendering style. Default value is 'compact'.
Possible values include: 'compact', 'expanded'
:type style: str
:param is_multi_select: Define if this input field allows multiple
selections. Default value is false.
:type is_multi_select: bool
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"id": {"key": "id", "type": "str"},
"is_required": {"key": "isRequired", "type": "bool"},
"title": {"key": "title", "type": "str"},
"value": {"key": "value", "type": "str"},
"choices": {
"key": "choices",
"type": "[O365ConnectorCardMultichoiceInputChoice]",
},
"style": {"key": "style", "type": "str"},
"is_multi_select": {"key": "isMultiSelect", "type": "bool"},
}
def __init__(
self,
*,
type=None,
id: str = None,
is_required: bool = None,
title: str = None,
value: str = None,
choices=None,
style=None,
is_multi_select: bool = None,
**kwargs
) -> None:
super(O365ConnectorCardMultichoiceInput, self).__init__(
type=type,
id=id,
is_required=is_required,
title=title,
value=value,
**kwargs
)
self.choices = choices
self.style = style
self.is_multi_select = is_multi_select
class O365ConnectorCardMultichoiceInputChoice(Model):
"""O365O365 connector card multiple choice input item.
:param display: The text rendered on ActionCard.
:type display: str
:param value: The value received as results.
:type value: str
"""
_attribute_map = {
"display": {"key": "display", "type": "str"},
"value": {"key": "value", "type": "str"},
}
def __init__(self, *, display: str = None, value: str = None, **kwargs) -> None:
super(O365ConnectorCardMultichoiceInputChoice, self).__init__(**kwargs)
self.display = display
self.value = value
class O365ConnectorCardOpenUri(O365ConnectorCardActionBase):
"""O365 connector card OpenUri action.
:param type: Type of the action. Possible values include: 'ViewAction',
'OpenUri', 'HttpPOST', 'ActionCard'
:type type: str
:param name: Name of the action that will be used as button title
:type name: str
:param id: Action Id
:type id: str
:param targets: Target os / urls
:type targets:
list[~botframework.connector.teams.models.O365ConnectorCardOpenUriTarget]
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"name": {"key": "name", "type": "str"},
"id": {"key": "@id", "type": "str"},
"targets": {"key": "targets", "type": "[O365ConnectorCardOpenUriTarget]"},
}
def __init__(
self, *, type=None, name: str = None, id: str = None, targets=None, **kwargs
) -> None:
super(O365ConnectorCardOpenUri, self).__init__(
type=type, name=name, id=id, **kwargs
)
self.targets = targets
class O365ConnectorCardOpenUriTarget(Model):
"""O365 connector card OpenUri target.
:param os: Target operating system. Possible values include: 'default',
'iOS', 'android', 'windows'
:type os: str
:param uri: Target url
:type uri: str
"""
_attribute_map = {
"os": {"key": "os", "type": "str"},
"uri": {"key": "uri", "type": "str"},
}
def __init__(self, *, os=None, uri: str = None, **kwargs) -> None:
super(O365ConnectorCardOpenUriTarget, self).__init__(**kwargs)
self.os = os
self.uri = uri
class O365ConnectorCardSection(Model):
"""O365 connector card section.
:param title: Title of the section
:type title: str
:param text: Text for the section
:type text: str
:param activity_title: Activity title
:type activity_title: str
:param activity_subtitle: Activity subtitle
:type activity_subtitle: str
:param activity_text: Activity text
:type activity_text: str
:param activity_image: Activity image
:type activity_image: str
:param activity_image_type: Describes how Activity image is rendered.
Possible values include: 'avatar', 'article'
:type activity_image_type: str or
~botframework.connector.teams.models.enum
:param markdown: Use markdown for all text contents. Default value is
true.
:type markdown: bool
:param facts: Set of facts for the current section
:type facts:
list[~botframework.connector.teams.models.O365ConnectorCardFact]
:param images: Set of images for the current section
:type images:
list[~botframework.connector.teams.models.O365ConnectorCardImage]
:param potential_action: Set of actions for the current section
:type potential_action:
list[~botframework.connector.teams.models.O365ConnectorCardActionBase]
"""
_attribute_map = {
"title": {"key": "title", "type": "str"},
"text": {"key": "text", "type": "str"},
"activity_title": {"key": "activityTitle", "type": "str"},
"activity_subtitle": {"key": "activitySubtitle", "type": "str"},
"activity_text": {"key": "activityText", "type": "str"},
"activity_image": {"key": "activityImage", "type": "str"},
"activity_image_type": {"key": "activityImageType", "type": "str"},
"markdown": {"key": "markdown", "type": "bool"},
"facts": {"key": "facts", "type": "[O365ConnectorCardFact]"},
"images": {"key": "images", "type": "[O365ConnectorCardImage]"},
"potential_action": {
"key": "potentialAction",
"type": "[O365ConnectorCardActionBase]",
},
}
def __init__(
self,
*,
title: str = None,
text: str = None,
activity_title: str = None,
activity_subtitle: str = None,
activity_text: str = None,
activity_image: str = None,
activity_image_type=None,
markdown: bool = None,
facts=None,
images=None,
potential_action=None,
**kwargs
) -> None:
super(O365ConnectorCardSection, self).__init__(**kwargs)
self.title = title
self.text = text
self.activity_title = activity_title
self.activity_subtitle = activity_subtitle
self.activity_text = activity_text
self.activity_image = activity_image
self.activity_image_type = activity_image_type
self.markdown = markdown
self.facts = facts
self.images = images
self.potential_action = potential_action
class O365ConnectorCardTextInput(O365ConnectorCardInputBase):
"""O365 connector card text input.
:param type: Input type name. Possible values include: 'textInput',
'dateInput', 'multichoiceInput'
:type type: str
:param id: Input Id. It must be unique per entire O365 connector card.
:type id: str
:param is_required: Define if this input is a required field. Default
value is false.
:type is_required: bool
:param title: Input title that will be shown as the placeholder
:type title: str
:param value: Default value for this input field
:type value: str
:param is_multiline: Define if text input is allowed for multiple lines.
Default value is false.
:type is_multiline: bool
:param max_length: Maximum length of text input. Default value is
unlimited.
:type max_length: float
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"id": {"key": "id", "type": "str"},
"is_required": {"key": "isRequired", "type": "bool"},
"title": {"key": "title", "type": "str"},
"value": {"key": "value", "type": "str"},
"is_multiline": {"key": "isMultiline", "type": "bool"},
"max_length": {"key": "maxLength", "type": "float"},
}
def __init__(
self,
*,
type=None,
id: str = None,
is_required: bool = None,
title: str = None,
value: str = None,
is_multiline: bool = None,
max_length: float = None,
**kwargs
) -> None:
super(O365ConnectorCardTextInput, self).__init__(
type=type,
id=id,
is_required=is_required,
title=title,
value=value,
**kwargs
)
self.is_multiline = is_multiline
self.max_length = max_length
class O365ConnectorCardViewAction(O365ConnectorCardActionBase):
"""O365 connector card ViewAction action.
:param type: Type of the action. Possible values include: 'ViewAction',
'OpenUri', 'HttpPOST', 'ActionCard'
:type type: str
:param name: Name of the action that will be used as button title
:type name: str
:param id: Action Id
:type id: str
:param target: Target urls, only the first url effective for card button
:type target: list[str]
"""
_attribute_map = {
"type": {"key": "@type", "type": "str"},
"name": {"key": "name", "type": "str"},
"id": {"key": "@id", "type": "str"},
"target": {"key": "target", "type": "[str]"},
}
def __init__(
self, *, type=None, name: str = None, id: str = None, target=None, **kwargs
) -> None:
super(O365ConnectorCardViewAction, self).__init__(
type=type, name=name, id=id, **kwargs
)
self.target = target
class SigninStateVerificationQuery(Model):
"""Signin state (part of signin action auth flow) verification invoke query.
:param state: The state string originally received when the signin web
flow is finished with a state posted back to client via tab SDK
microsoftTeams.authentication.notifySuccess(state)
:type state: str
"""
_attribute_map = {
"state": {"key": "state", "type": "str"},
}
def __init__(self, *, state: str = None, **kwargs) -> None:
super(SigninStateVerificationQuery, self).__init__(**kwargs)
self.state = state
class TaskModuleResponseBase(Model):
"""Base class for Task Module responses.
:param type: Choice of action options when responding to the task/submit
message. Possible values include: 'message', 'continue'
:type type: str
"""
_attribute_map = {
"type": {"key": "type", "type": "str"},
}
def __init__(self, *, type=None, **kwargs) -> None:
super(TaskModuleResponseBase, self).__init__(**kwargs)
self.type = type
class TaskModuleContinueResponse(TaskModuleResponseBase):
"""Task Module Response with continue action.
:param value: The JSON for the Adaptive card to appear in the task module.
:type value: ~botframework.connector.teams.models.TaskModuleTaskInfo
"""
_attribute_map = {
"type": {"key": "type", "type": "str"},
"value": {"key": "value", "type": "TaskModuleTaskInfo"},
}
def __init__(self, *, value=None, **kwargs) -> None:
super(TaskModuleContinueResponse, self).__init__(type="continue", **kwargs)
self.value = value
class TaskModuleMessageResponse(TaskModuleResponseBase):
"""Task Module response with message action.
:param value: Teams will display the value of value in a popup message
box.
:type value: str
"""
_attribute_map = {
"type": {"key": "type", "type": "str"},
"value": {"key": "value", "type": "str"},
}
def __init__(self, *, value: str = None, **kwargs) -> None:
super(TaskModuleMessageResponse, self).__init__(type="message", **kwargs)
self.value = value
class TaskModuleRequestContext(Model):
"""Current user context, i.e., the current theme.
:param theme:
:type theme: str
"""
_attribute_map = {
"theme": {"key": "theme", "type": "str"},
}
def __init__(self, *, theme: str = None, **kwargs) -> None:
super(TaskModuleRequestContext, self).__init__(**kwargs)
self.theme = theme
class TaskModuleResponse(Model):
"""Envelope for Task Module Response.
:param task: The JSON for the Adaptive card to appear in the task module.
:type task: ~botframework.connector.teams.models.TaskModuleResponseBase
:param cache_info: CacheInfo for this TaskModuleResponse.
:type cache_info: ~botframework.connector.teams.models.CacheInfo
"""
_attribute_map = {
"task": {"key": "task", "type": "TaskModuleResponseBase"},
"cache_info": {"key": "cacheInfo", "type": "CacheInfo"},
}
def __init__(self, *, task=None, cache_info=None, **kwargs) -> None:
super(TaskModuleResponse, self).__init__(**kwargs)
self.task = task
self.cache_info = cache_info
class TaskModuleTaskInfo(Model):
"""Metadata for a Task Module.
:param title: Appears below the app name and to the right of the app icon.
:type title: str
:param height: This can be a number, representing the task module's height
in pixels, or a string, one of: small, medium, large.
:type height: object
:param width: This can be a number, representing the task module's width
in pixels, or a string, one of: small, medium, large.
:type width: object
:param url: The URL of what is loaded as an iframe inside the task module.
One of url or card is required.
:type url: str
:param card: The JSON for the Adaptive card to appear in the task module.
:type card: ~botframework.connector.teams.models.Attachment
:param fallback_url: If a client does not support the task module feature,
this URL is opened in a browser tab.
:type fallback_url: str
:param completion_bot_id: If a client does not support the task module
feature, this URL is opened in a browser tab.
:type completion_bot_id: str
"""
_attribute_map = {
"title": {"key": "title", "type": "str"},
"height": {"key": "height", "type": "object"},
"width": {"key": "width", "type": "object"},
"url": {"key": "url", "type": "str"},
"card": {"key": "card", "type": "Attachment"},
"fallback_url": {"key": "fallbackUrl", "type": "str"},
"completion_bot_id": {"key": "completionBotId", "type": "str"},
}
def __init__(
self,
*,
title: str = None,
height=None,
width=None,
url: str = None,
card=None,
fallback_url: str = None,
completion_bot_id: str = None,
**kwargs
) -> None:
super(TaskModuleTaskInfo, self).__init__(**kwargs)
self.title = title
self.height = height
self.width = width
self.url = url
self.card = card
self.fallback_url = fallback_url
self.completion_bot_id = completion_bot_id
class TeamDetails(Model):
"""Details related to a team.
:param id: Unique identifier representing a team
:type id: str
:param name: Name of team.
:type name: str
:param aad_group_id: Azure Active Directory (AAD) Group Id for the team.
:type aad_group_id: str
:param channel_count: The count of channels in the team.
:type channel_count: int
:param member_count: The count of members in the team.
:type member_count: int
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"aad_group_id": {"key": "aadGroupId", "type": "str"},
"channel_count": {"key": "channelCount", "type": "int"},
"member_count": {"key": "memberCount", "type": "int"},
}
def __init__(
self,
*,
id: str = None,
name: str = None,
aad_group_id: str = None,
member_count: int = None,
channel_count: int = None,
**kwargs
) -> None:
super(TeamDetails, self).__init__(**kwargs)
self.id = id
self.name = name
self.aad_group_id = aad_group_id
self.channel_count = channel_count
self.member_count = member_count
class TeamInfo(Model):
"""Describes a team.
:param id: Unique identifier representing a team
:type id: str
:param name: Name of team.
:type name: str
:param name: Azure AD Teams group ID.
:type name: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"aad_group_id": {"key": "aadGroupId", "type": "str"},
}
def __init__(
self, *, id: str = None, name: str = None, aad_group_id: str = None, **kwargs
) -> None:
super(TeamInfo, self).__init__(**kwargs)
self.id = id
self.name = name
self.aad_group_id = aad_group_id
class TeamsChannelAccount(ChannelAccount):
"""Teams channel account detailing user Azure Active Directory details.
:param id: Channel id for the user or bot on this channel (Example:
joe@smith.com, or @joesmith or 123456)
:type id: str
:param name: Display friendly name
:type name: str
:param given_name: Given name part of the user name.
:type given_name: str
:param surname: Surname part of the user name.
:type surname: str
:param email: Email Id of the user.
:type email: str
:param user_principal_name: Unique user principal name.
:type user_principal_name: str
:param tenant_id: Tenant Id of the user.
:type tenant_id: str
:param user_role: User Role of the user.
:type user_role: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"given_name": {"key": "givenName", "type": "str"},
"surname": {"key": "surname", "type": "str"},
"email": {"key": "email", "type": "str"},
"user_principal_name": {"key": "userPrincipalName", "type": "str"},
"aad_object_id": {"key": "aadObjectId", "type": "str"},
"tenant_id": {"key": "tenantId", "type": "str"},
"user_role": {"key": "userRole", "type": "str"},
}
def __init__(
self,
*,
id: str = None,
name: str = None,
given_name: str = None,
surname: str = None,
email: str = None,
user_principal_name: str = None,
tenant_id: str = None,
user_role: str = None,
**kwargs
) -> None:
super(TeamsChannelAccount, self).__init__(id=id, name=name, **kwargs)
self.given_name = given_name
self.surname = surname
self.email = email
self.user_principal_name = user_principal_name
self.tenant_id = tenant_id
self.user_role = user_role
class TeamsPagedMembersResult(PagedMembersResult):
"""Page of members for Teams.
:param continuation_token: Paging token
:type continuation_token: str
:param members: The Teams Channel Accounts.
:type members: list[~botframework.connector.models.TeamsChannelAccount]
"""
_attribute_map = {
"continuation_token": {"key": "continuationToken", "type": "str"},
"members": {"key": "members", "type": "[TeamsChannelAccount]"},
}
def __init__(
self,
*,
continuation_token: str = None,
members: List[TeamsChannelAccount] = None,
**kwargs
) -> None:
super(TeamsPagedMembersResult, self).__init__(
continuation_token=continuation_token, members=members, **kwargs
)
self.continuation_token = continuation_token
self.members = members
class TeamsChannelData(Model):
"""Channel data specific to messages received in Microsoft Teams.
:param channel: Information about the channel in which the message was
sent
:type channel: ~botframework.connector.teams.models.ChannelInfo
:param event_type: Type of event.
:type event_type: str
:param team: Information about the team in which the message was sent
:type team: ~botframework.connector.teams.models.TeamInfo
:param notification: Notification settings for the message
:type notification: ~botframework.connector.teams.models.NotificationInfo
:param tenant: Information about the tenant in which the message was sent
:type tenant: ~botframework.connector.teams.models.TenantInfo
:param meeting: Information about the meeting in which the message was sent
:type meeting: ~botframework.connector.teams.models.TeamsMeetingInfo
"""
_attribute_map = {
"channel": {"key": "channel", "type": "ChannelInfo"},
"event_type": {"key": "eventType", "type": "str"},
"team": {"key": "team", "type": "TeamInfo"},
"notification": {"key": "notification", "type": "NotificationInfo"},
"tenant": {"key": "tenant", "type": "TenantInfo"},
"meeting": {"key": "meeting", "type": "TeamsMeetingInfo"},
}
def __init__(
self,
*,
channel=None,
event_type: str = None,
team=None,
notification=None,
tenant=None,
meeting=None,
**kwargs
) -> None:
super(TeamsChannelData, self).__init__(**kwargs)
self.channel = channel
# doing camel case here since that's how the data comes in
self.event_type = event_type
self.team = team
self.notification = notification
self.tenant = tenant
self.meeting = meeting
class TenantInfo(Model):
"""Describes a tenant.
:param id: Unique identifier representing a tenant
:type id: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, *, id: str = None, **kwargs) -> None:
super(TenantInfo, self).__init__(**kwargs)
self.id = id
class TeamsMeetingInfo(Model):
"""Describes a Teams Meeting.
:param id: Unique identifier representing a meeting
:type id: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, *, id: str = None, **kwargs) -> None:
super(TeamsMeetingInfo, self).__init__(**kwargs)
self.id = id
class MeetingParticipantInfo(Model):
"""Teams meeting participant details.
:param role: Role of the participant in the current meeting.
:type role: str
:param in_meeting: True, if the participant is in the meeting.
:type in_meeting: bool
"""
_attribute_map = {
"role": {"key": "role", "type": "str"},
"in_meeting": {"key": "inMeeting", "type": "bool"},
}
def __init__(self, *, role: str = None, in_meeting: bool = None, **kwargs) -> None:
super(MeetingParticipantInfo, self).__init__(**kwargs)
self.role = role
self.in_meeting = in_meeting
class TeamsMeetingParticipant(Model):
"""Teams participant channel account detailing user Azure Active Directory and meeting participant details.
:param user: Teams Channel Account information for this meeting participant
:type user: TeamsChannelAccount
:param meeting: >Information specific to this participant in the specific meeting.
:type meeting: MeetingParticipantInfo
:param conversation: Conversation Account for the meeting.
:type conversation: ConversationAccount
"""
_attribute_map = {
"user": {"key": "user", "type": "TeamsChannelAccount"},
"meeting": {"key": "meeting", "type": "MeetingParticipantInfo"},
"conversation": {"key": "conversation", "type": "ConversationAccount"},
}
def __init__(
self,
*,
user: TeamsChannelAccount = None,
meeting: MeetingParticipantInfo = None,
conversation: ConversationAccount = None,
**kwargs
) -> None:
super(TeamsMeetingParticipant, self).__init__(**kwargs)
self.user = user
self.meeting = meeting
self.conversation = conversation
class TabContext(Model):
"""
Current tab request context, i.e., the current theme.
:param theme: Gets or sets the current user's theme.
:type theme: str
"""
_attribute_map = {
"theme": {"key": "theme", "type": "str"},
}
def __init__(self, *, theme=None, **kwargs) -> None:
super(TabContext, self).__init__(**kwargs)
self.theme = theme
self._custom_init()
def _custom_init(self):
return
class TabRequest(Model):
"""
Invoke ('tab/fetch') request value payload.
:param tab_entity_context: Gets or sets current tab entity request context.
:type tab_entity_context:
~botframework.connector.teams.models.TabEntityContext
:param context: Gets or sets current tab entity request context.
:type context:
~botframework.connector.teams.models.TabContext
:param state: Gets or sets state, which is the magic code for OAuth Flow.
:type state: str
"""
_attribute_map = {
"tab_entity_context": {"key": "tabContext", "type": "TabEntityContext"},
"context": {"key": "context", "type": "TabContext"},
"state": {"key": "state", "type": "str"},
}
def __init__(
self, *, tab_entity_context=None, context=None, state=None, **kwargs
) -> None:
super(TabRequest, self).__init__(**kwargs)
self.tab_entity_context = tab_entity_context
self.context = context
self.state = state
self._custom_init()
def _custom_init(self):
return
class TabResponseCard(Model):
"""
Envelope for cards for a Tab request.
:param card: Gets or sets adaptive card for this card tab response.
:type card: object
"""
_attribute_map = {
"card": {"key": "card", "type": "object"},
}
def __init__(self, *, card=None, **kwargs) -> None:
super(TabResponseCard, self).__init__(**kwargs)
self.card = card
self._custom_init()
def _custom_init(self):
return
class TabResponseCards(Model):
"""
Envelope for cards for a TabResponse.
:param cards: Gets or sets adaptive card for this card tab response.
:type cards:
list[ ~botframework.connector.teams.models.TabResponseCard]
"""
_attribute_map = {
"cards": {"key": "cards", "type": "[TabResponseCard]"},
}
def __init__(self, *, cards=None, **kwargs) -> None:
super(TabResponseCards, self).__init__(**kwargs)
self.cards = cards
self._custom_init()
def _custom_init(self):
return
class TabResponsePayload(Model):
"""
Initializes a new instance of the TabResponsePayload class.
:param type: Gets or sets choice of action options when responding to the
tab/fetch message. Possible values include: 'continue', 'auth' or 'silentAuth'
:type type: str
:param value: Gets or sets the TabResponseCards when responding to
tab/fetch activity with type of 'continue'.
:type value: TabResponseCards
:param suggested_actions: Gets or sets the Suggested Actions for this card tab.
:type suggested_actions: TabSuggestedActions
"""
_attribute_map = {
"type": {"key": "type", "type": "str"},
"value": {"key": "value", "type": "TabResponseCards"},
"suggested_actions": {"key": "suggestedActions", "type": "TabSuggestedActions"},
}
def __init__(
self, *, type=None, value=None, suggested_actions=None, **kwargs
) -> None:
super(TabResponsePayload, self).__init__(**kwargs)
self.type = type
self.value = value
self.suggested_actions = suggested_actions
self._custom_init()
def _custom_init(self):
return
class TabResponse(Model):
"""
Envelope for Card Tab Response Payload.
:param tab: Possible values include: 'continue', 'auth' or 'silentAuth'
:type type: ~botframework.connector.teams.models.TabResponsePayload
"""
_attribute_map = {
"tab": {"key": "tab", "type": "TabResponsePayload"},
}
def __init__(self, *, tab=None, **kwargs) -> None:
super(TabResponse, self).__init__(**kwargs)
self.tab = tab
self._custom_init()
def _custom_init(self):
return
class TabSumit(Model):
"""
Invoke ('tab/submit') request value payload.
:param tab_entity_context: Gets or sets current tab entity request context.
:type tab_entity_context:
~botframework.connector.teams.models.TabEntityContext
:param context: Gets or sets current tab entity request context.
:type context:
~botframework.connector.teams.models.TabContext
:param data: User input data. Free payload containing properties of key-value pairs.
:type data:
~botframework.connector.teams.models.TabSubmitData
"""
_attribute_map = {
"tab_entity_context": {"key": "tabContext", "type": "TabEntityContext"},
"context": {"key": "context", "type": "TabContext"},
"data": {"key": "data", "type": "TabSubmitData"},
}
def __init__(
self, *, tab_entity_context=None, context=None, data=None, **kwargs
) -> None:
super(TabSumit, self).__init__(**kwargs)
self.tab_entity_context = tab_entity_context
self.context = context
self.data = data
self._custom_init()
def _custom_init(self):
return
class TabSubmitData(Model):
"""
Invoke ('tab/submit') request value payload data.
:param type: Currently, 'tab/submit'.
:type type: str
:param properties: Gets or sets properties that are not otherwise defined by the TabSubmit
type but that might appear in the serialized REST JSON object.
:type properties: object
"""
_attribute_map = {
"type": {"key": "type", "type": "str"},
"properties": {"key": "properties", "type": "{object}"},
}
def __init__(self, *, type=None, properties=None, **kwargs) -> None:
super(TabSubmitData, self).__init__(**kwargs)
self.type = type
self.properties = properties
self._custom_init()
def _custom_init(self):
return
class TabSubmit(Model):
"""
Initializes a new instance of the TabSubmit class.
:param tab_entity_context: Gets or sets current tab entity request context.
:type tab_entity_context: ~botframework.connector.teams.models.TabEntityContext
:param context: Gets or sets current user context, i.e., the current theme.
:type context: ~botframework.connector.teams.models.TabContext
:param data: User input data. Free payload containing properties of key-value pairs.
:type data: ~botframework.connector.teams.models.TabSubmitData
"""
_attribute_map = {
"tab_entity_context": {"key": "tabContext", "type": "TabEntityContext"},
"context": {"key": "context", "type": "TabContext"},
"data": {"key": "data", "type": "TabSubmitData"},
}
def __init__(
self, *, tab_entity_context=None, context=None, data=None, **kwargs
) -> None:
super(TabSubmit, self).__init__(**kwargs)
self.tab_entity_context = tab_entity_context
self.context = context
self.data = data
self._custom_init()
def _custom_init(self):
return
class TabSuggestedActions(Model):
"""
Tab SuggestedActions (Only when type is 'auth' or 'silentAuth').
:param actions: Gets or sets adaptive card for this card tab response.
:type actions: list[~botframework.connector.models.CardAction]
"""
_attribute_map = {
"actions": {"key": "actions", "type": "[CardAction]"},
}
def __init__(self, *, actions=None, **kwargs) -> None:
super(TabSuggestedActions, self).__init__(**kwargs)
self.actions = actions
self._custom_init()
def _custom_init(self):
return
class TaskModuleCardResponse(TaskModuleResponseBase):
"""
Tab Response to 'task/submit' from a tab.
:param value: The JSON for the Adaptive cards to appear in the tab.
:type value: ~botframework.connector.teams.models.TabResponse
"""
_attribute_map = {
"value": {"key": "value", "type": "TabResponse"},
}
def __init__(self, *, value=None, **kwargs) -> None:
super(TaskModuleCardResponse, self).__init__("continue", **kwargs)
self.value = value
self._custom_init()
def _custom_init(self):
return
class MeetingDetailsBase(Model):
"""Specific details of a Teams meeting.
:param id: The meeting's Id, encoded as a BASE64 string.
:type id: str
:param join_url: The URL used to join the meeting.
:type join_url: str
:param title: The title of the meeting.
:type title: str
"""
_attribute_map = {
"id": {"key": "uniqueId", "type": "str"},
"join_url": {"key": "joinUrl", "type": "str"},
"title": {"key": "title", "type": "str"},
}
def __init__(
self, *, id: str = None, join_url: str = None, title: str = None, **kwargs
) -> None:
super(MeetingDetailsBase, self).__init__(**kwargs)
self.id = id
self.join_url = join_url
self.title = title
class MeetingDetails(MeetingDetailsBase):
"""Specific details of a Teams meeting.
:param ms_graph_resource_id: The MsGraphResourceId, used specifically for MS Graph API calls.
:type ms_graph_resource_id: str
:param scheduled_start_time: The meeting's scheduled start time, in UTC.
:type scheduled_start_time: str
:param scheduled_end_time: The meeting's scheduled end time, in UTC.
:type scheduled_end_time: str
:param type: The meeting's type.
:type type: str
"""
_attribute_map = {
"ms_graph_resource_id": {"key": "msGraphResourceId", "type": "str"},
"scheduled_start_time": {"key": "scheduledStartTime", "type": "str"},
"scheduled_end_time": {"key": "scheduledEndTime", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(
self,
*,
ms_graph_resource_id: str = None,
scheduled_start_time: str = None,
scheduled_end_time: str = None,
type: str = None,
**kwargs
) -> None:
super(MeetingDetails, self).__init__(**kwargs)
self.ms_graph_resource_id = ms_graph_resource_id
self.scheduled_start_time = scheduled_start_time
self.scheduled_end_time = scheduled_end_time
self.type = type
class MeetingInfo(Model):
"""General information about a Teams meeting.
:param details: The specific details of a Teams meeting.
:type details: ~botframework.connector.teams.models.MeetingDetails
:param conversation: The Conversation Account for the meeting.
:type conversation: ~botbuilder.schema.models.ConversationAccount
:param organizer: The meeting's scheduled start time, in UTC.
:type organizer: ~botbuilder.schema.models.TeamsChannelAccount
"""
_attribute_map = {
"details": {"key": "details", "type": "object"},
"conversation": {"key": "conversation", "type": "object"},
"organizer": {"key": "organizer", "type": "object"},
}
def __init__(
self,
*,
details: MeetingDetails = None,
conversation: ConversationAccount = None,
organizer: TeamsChannelAccount = None,
**kwargs
) -> None:
super(MeetingInfo, self).__init__(**kwargs)
self.details = details
self.conversation = conversation
self.organizer = organizer
class MeetingEventDetails(MeetingDetailsBase):
"""Base class for Teams meting start and end events.
:param meeting_type: The meeting's type.
:type meeting_type: str
"""
_attribute_map = {"meeting_type": {"key": "MeetingType", "type": "str"}}
def __init__(self, *, meeting_type: str = None, **kwargs):
super(MeetingEventDetails, self).__init__(**kwargs)
self.meeting_type = meeting_type
class MeetingStartEventDetails(MeetingDetailsBase):
"""Specific details of a Teams meeting start event.
:param start_time: Timestamp for meeting start, in UTC.
:type start_time: str
"""
_attribute_map = {"start_time": {"key": "StartTime", "type": "str"}}
def __init__(self, *, start_time: str = None, **kwargs):
super(MeetingStartEventDetails, self).__init__(**kwargs)
self.start_time = start_time
class MeetingEndEventDetails(MeetingDetailsBase):
"""Specific details of a Teams meeting end event.
:param end_time: Timestamp for meeting end, in UTC.
:type end_time: str
"""
_attribute_map = {"end_time": {"key": "EndTime", "type": "str"}}
def __init__(self, *, end_time: str = None, **kwargs):
super(MeetingEndEventDetails, self).__init__(**kwargs)
self.end_time = end_time
|