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 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
// DO NOT EDIT ! // This file was generated automatically from 'src/mako/api/lib.rs.mako' // DO NOT EDIT ! //! This documentation was generated from *Firebase Dynamic Links* crate version *1.0.8+20181008*, where *20181008* is the exact revision of the *firebasedynamiclinks:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.8*. //! //! Everything else about the *Firebase Dynamic Links* *v1* API can be found at the //! [official documentation site](https://firebase.google.com/docs/dynamic-links/). //! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/master/gen/firebasedynamiclinks1). //! # Features //! //! Handle the following *Resources* with ease from the central [hub](struct.FirebaseDynamicLinks.html) ... //! //! * [managed short links](struct.ManagedShortLink.html) //! * [*create*](struct.ManagedShortLinkCreateCall.html) //! * short links //! * [*create*](struct.ShortLinkCreateCall.html) //! //! Other activities are ... //! //! * [get link stats](struct.MethodGetLinkStatCall.html) //! * [install attribution](struct.MethodInstallAttributionCall.html) //! * [reopen attribution](struct.MethodReopenAttributionCall.html) //! //! //! //! Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](http://byron.github.io/google-apis-rs). //! //! # Structure of this Library //! //! The API is structured into the following primary items: //! //! * **[Hub](struct.FirebaseDynamicLinks.html)** //! * a central object to maintain state and allow accessing all *Activities* //! * creates [*Method Builders*](trait.MethodsBuilder.html) which in turn //! allow access to individual [*Call Builders*](trait.CallBuilder.html) //! * **[Resources](trait.Resource.html)** //! * primary types that you can apply *Activities* to //! * a collection of properties and *Parts* //! * **[Parts](trait.Part.html)** //! * a collection of properties //! * never directly used in *Activities* //! * **[Activities](trait.CallBuilder.html)** //! * operations to apply to *Resources* //! //! All *structures* are marked with applicable traits to further categorize them and ease browsing. //! //! Generally speaking, you can invoke *Activities* like this: //! //! ```Rust,ignore //! let r = hub.resource().activity(...).doit() //! ``` //! //! Or specifically ... //! //! ```ignore //! let r = hub.methods().install_attribution(...).doit() //! ``` //! //! The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities` //! supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be //! specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired. //! The `doit()` method performs the actual communication with the server and returns the respective result. //! //! # Usage //! //! ## Setting up your Project //! //! To use this library, you would put the following lines into your `Cargo.toml` file: //! //! ```toml //! [dependencies] //! google-firebasedynamiclinks1 = "*" //! # This project intentionally uses an old version of Hyper. See //! # https://github.com/Byron/google-apis-rs/issues/173 for more //! # information. //! hyper = "^0.10" //! hyper-rustls = "^0.6" //! serde = "^1.0" //! serde_json = "^1.0" //! yup-oauth2 = "^1.0" //! ``` //! //! ## A complete example //! //! ```test_harness,no_run //! extern crate hyper; //! extern crate hyper_rustls; //! extern crate yup_oauth2 as oauth2; //! extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; //! use firebasedynamiclinks1::GetIosPostInstallAttributionRequest; //! use firebasedynamiclinks1::{Result, Error}; //! # #[test] fn egal() { //! use std::default::Default; //! use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; //! use firebasedynamiclinks1::FirebaseDynamicLinks; //! //! // Get an ApplicationSecret instance by some means. It contains the `client_id` and //! // `client_secret`, among other things. //! let secret: ApplicationSecret = Default::default(); //! // Instantiate the authenticator. It will choose a suitable authentication flow for you, //! // unless you replace `None` with the desired Flow. //! // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about //! // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and //! // retrieve them from storage. //! let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, //! hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), //! <MemoryStorage as Default>::default(), None); //! let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); //! // As the method needs a request, you would usually fill it with the desired information //! // into the respective structure. Some of the parts shown here might not be applicable ! //! // Values shown here are possibly random and not representative ! //! let mut req = GetIosPostInstallAttributionRequest::default(); //! //! // You can configure optional parameters by calling the respective setters at will, and //! // execute the final call using `doit()`. //! // Values shown here are possibly random and not representative ! //! let result = hub.methods().install_attribution(req) //! .doit(); //! //! match result { //! Err(e) => match e { //! // The Error enum provides details about what exactly happened. //! // You can also just use its `Debug`, `Display` or `Error` traits //! Error::HttpError(_) //! |Error::MissingAPIKey //! |Error::MissingToken(_) //! |Error::Cancelled //! |Error::UploadSizeLimitExceeded(_, _) //! |Error::Failure(_) //! |Error::BadRequest(_) //! |Error::FieldClash(_) //! |Error::JsonDecodeError(_, _) => println!("{}", e), //! }, //! Ok(res) => println!("Success: {:?}", res), //! } //! # } //! ``` //! ## Handling Errors //! //! All errors produced by the system are provided either as [Result](enum.Result.html) enumeration as return value of //! the doit() methods, or handed as possibly intermediate results to either the //! [Hub Delegate](trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html). //! //! When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This //! makes the system potentially resilient to all kinds of errors. //! //! ## Uploads and Downloads //! If a method supports downloads, the response body, which is part of the [Result](enum.Result.html), should be //! read by you to obtain the media. //! If such a method also supports a [Response Result](trait.ResponseResult.html), it will return that by default. //! You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making //! this call: `.param("alt", "media")`. //! //! Methods supporting uploads can do so using up to 2 different protocols: //! *simple* and *resumable*. The distinctiveness of each is represented by customized //! `doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively. //! //! ## Customization and Callbacks //! //! You may alter the way an `doit()` method is called by providing a [delegate](trait.Delegate.html) to the //! [Method Builder](trait.CallBuilder.html) before making the final `doit()` call. //! Respective methods will be called to provide progress information, as well as determine whether the system should //! retry on failure. //! //! The [delegate trait](trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. //! //! ## Optional Parts in Server-Requests //! //! All structures provided by this library are made to be [enocodable](trait.RequestValue.html) and //! [decodable](trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses //! are valid. //! Most optionals are are considered [Parts](trait.Part.html) which are identifiable by name, which will be sent to //! the server to indicate either the set parts of the request or the desired parts in the response. //! //! ## Builder Arguments //! //! Using [method builders](trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. //! These will always take a single argument, for which the following statements are true. //! //! * [PODs][wiki-pod] are handed by copy //! * strings are passed as `&str` //! * [request values](trait.RequestValue.html) are moved //! //! Arguments will always be copied or cloned into the builder, to make them independent of their original life times. //! //! [wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure //! [builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern //! [google-go-api]: https://github.com/google/google-api-go-client //! //! // Unused attributes happen thanks to defined, but unused structures // We don't warn about this, as depending on the API, some data structures or facilities are never used. // Instead of pre-determining this, we just disable the lint. It's manually tuned to not have any // unused imports in fully featured APIs. Same with unused_mut ... . #![allow(unused_imports, unused_mut, dead_code)] // DO NOT EDIT ! // This file was generated automatically from 'src/mako/api/lib.rs.mako' // DO NOT EDIT ! #[macro_use] extern crate serde_derive; extern crate hyper; extern crate serde; extern crate serde_json; extern crate yup_oauth2 as oauth2; extern crate mime; extern crate url; mod cmn; use std::collections::HashMap; use std::cell::RefCell; use std::borrow::BorrowMut; use std::default::Default; use std::collections::BTreeMap; use serde_json as json; use std::io; use std::fs; use std::mem; use std::thread::sleep; use std::time::Duration; pub use cmn::{MultiPartReader, ToParts, MethodInfo, Result, Error, CallBuilder, Hub, ReadSeek, Part, ResponseResult, RequestValue, NestedType, Delegate, DefaultDelegate, MethodsBuilder, Resource, ErrorResponse, remove_json_null_values}; // ############## // UTILITIES ### // ############ /// Identifies the an OAuth2 authorization scope. /// A scope is needed when requesting an /// [authorization token](https://developers.google.com/youtube/v3/guides/authentication). #[derive(PartialEq, Eq, Hash)] pub enum Scope { /// View and administer all your Firebase data and settings Firebase, } impl AsRef<str> for Scope { fn as_ref(&self) -> &str { match *self { Scope::Firebase => "https://www.googleapis.com/auth/firebase", } } } impl Default for Scope { fn default() -> Scope { Scope::Firebase } } // ######## // HUB ### // ###### /// Central instance to access all FirebaseDynamicLinks related resource activities /// /// # Examples /// /// Instantiate a new hub /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate yup_oauth2 as oauth2; /// extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// use firebasedynamiclinks1::GetIosPostInstallAttributionRequest; /// use firebasedynamiclinks1::{Result, Error}; /// # #[test] fn egal() { /// use std::default::Default; /// use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// // Get an ApplicationSecret instance by some means. It contains the `client_id` and /// // `client_secret`, among other things. /// let secret: ApplicationSecret = Default::default(); /// // Instantiate the authenticator. It will choose a suitable authentication flow for you, /// // unless you replace `None` with the desired Flow. /// // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about /// // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and /// // retrieve them from storage. /// let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// <MemoryStorage as Default>::default(), None); /// let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // As the method needs a request, you would usually fill it with the desired information /// // into the respective structure. Some of the parts shown here might not be applicable ! /// // Values shown here are possibly random and not representative ! /// let mut req = GetIosPostInstallAttributionRequest::default(); /// /// // You can configure optional parameters by calling the respective setters at will, and /// // execute the final call using `doit()`. /// // Values shown here are possibly random and not representative ! /// let result = hub.methods().install_attribution(req) /// .doit(); /// /// match result { /// Err(e) => match e { /// // The Error enum provides details about what exactly happened. /// // You can also just use its `Debug`, `Display` or `Error` traits /// Error::HttpError(_) /// |Error::MissingAPIKey /// |Error::MissingToken(_) /// |Error::Cancelled /// |Error::UploadSizeLimitExceeded(_, _) /// |Error::Failure(_) /// |Error::BadRequest(_) /// |Error::FieldClash(_) /// |Error::JsonDecodeError(_, _) => println!("{}", e), /// }, /// Ok(res) => println!("Success: {:?}", res), /// } /// # } /// ``` pub struct FirebaseDynamicLinks<C, A> { client: RefCell<C>, auth: RefCell<A>, _user_agent: String, _base_url: String, _root_url: String, } impl<'a, C, A> Hub for FirebaseDynamicLinks<C, A> {} impl<'a, C, A> FirebaseDynamicLinks<C, A> where C: BorrowMut<hyper::Client>, A: oauth2::GetToken { pub fn new(client: C, authenticator: A) -> FirebaseDynamicLinks<C, A> { FirebaseDynamicLinks { client: RefCell::new(client), auth: RefCell::new(authenticator), _user_agent: "google-api-rust-client/1.0.8".to_string(), _base_url: "https://firebasedynamiclinks.googleapis.com/".to_string(), _root_url: "https://firebasedynamiclinks.googleapis.com/".to_string(), } } pub fn managed_short_links(&'a self) -> ManagedShortLinkMethods<'a, C, A> { ManagedShortLinkMethods { hub: &self } } pub fn methods(&'a self) -> MethodMethods<'a, C, A> { MethodMethods { hub: &self } } pub fn short_links(&'a self) -> ShortLinkMethods<'a, C, A> { ShortLinkMethods { hub: &self } } /// Set the user-agent header field to use in all requests to the server. /// It defaults to `google-api-rust-client/1.0.8`. /// /// Returns the previously set user-agent. pub fn user_agent(&mut self, agent_name: String) -> String { mem::replace(&mut self._user_agent, agent_name) } /// Set the base url to use in all requests to the server. /// It defaults to `https://firebasedynamiclinks.googleapis.com/`. /// /// Returns the previously set base url. pub fn base_url(&mut self, new_base_url: String) -> String { mem::replace(&mut self._base_url, new_base_url) } /// Set the root url to use in all requests to the server. /// It defaults to `https://firebasedynamiclinks.googleapis.com/`. /// /// Returns the previously set root url. pub fn root_url(&mut self, new_root_url: String) -> String { mem::replace(&mut self._root_url, new_root_url) } } // ############ // SCHEMAS ### // ########## /// Information of navigation behavior. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct NavigationInfo { /// If this option is on, FDL click will be forced to redirect rather than /// show an interstitial page. #[serde(rename="enableForcedRedirect")] pub enable_forced_redirect: Option<bool>, } impl Part for NavigationInfo {} /// Response for iSDK to execute strong match flow for post-install attribution. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [install attribution](struct.MethodInstallAttributionCall.html) (response) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct GetIosPostInstallAttributionResponse { /// Scion medium value to be propagated by iSDK to Scion at post-install. #[serde(rename="utmMedium")] pub utm_medium: Option<String>, /// Scion source value to be propagated by iSDK to Scion at post-install. #[serde(rename="utmSource")] pub utm_source: Option<String>, /// The minimum version for app, specified by dev through ?imv= parameter. /// Return to iSDK to allow app to evaluate if current version meets this. #[serde(rename="appMinimumVersion")] pub app_minimum_version: Option<String>, /// The confidence of the returned attribution. #[serde(rename="attributionConfidence")] pub attribution_confidence: Option<String>, /// User-agent specific custom-scheme URIs for iSDK to open. This will be set /// according to the user-agent tha the click was originally made in. There is /// no Safari-equivalent custom-scheme open URLs. /// ie: googlechrome://www.example.com /// ie: firefox://open-url?url=http://www.example.com /// ie: opera-http://example.com #[serde(rename="externalBrowserDestinationLink")] pub external_browser_destination_link: Option<String>, /// Instruction for iSDK to attemmpt to perform strong match. For instance, /// if browser does not support/allow cookie or outside of support browsers, /// this will be false. #[serde(rename="isStrongMatchExecutable")] pub is_strong_match_executable: Option<bool>, /// Which IP version the request was made from. #[serde(rename="requestIpVersion")] pub request_ip_version: Option<String>, /// Invitation ID attributed post-install via one of several techniques /// (fingerprint, copy unique). #[serde(rename="invitationId")] pub invitation_id: Option<String>, /// The entire FDL, expanded from a short link. It is the same as the /// requested_link, if it is long. Parameters from this should not be /// used directly (ie: server can default utm_[campaign|medium|source] /// to a value when requested_link lack them, server determine the best /// fallback_link when requested_link specifies >1 fallback links). #[serde(rename="resolvedLink")] pub resolved_link: Option<String>, /// Entire FDL (short or long) attributed post-install via one of several /// techniques (fingerprint, copy unique). #[serde(rename="requestedLink")] pub requested_link: Option<String>, /// The link to navigate to update the app if min version is not met. /// This is either (in order): 1) fallback link (from ?ifl= parameter, if /// specified by developer) or 2) AppStore URL (from ?isi= parameter, if /// specified), or 3) the payload link (from required link= parameter). #[serde(rename="fallbackLink")] pub fallback_link: Option<String>, /// Describes why match failed, ie: "discarded due to low confidence". /// This message will be publicly visible. #[serde(rename="matchMessage")] pub match_message: Option<String>, /// Scion campaign value to be propagated by iSDK to Scion at post-install. #[serde(rename="utmCampaign")] pub utm_campaign: Option<String>, /// The deep-link attributed post-install via one of several techniques /// (fingerprint, copy unique). #[serde(rename="deepLink")] pub deep_link: Option<String>, } impl ResponseResult for GetIosPostInstallAttributionResponse {} /// Android related attributes to the Dynamic Link. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct AndroidInfo { /// Android package name of the app. #[serde(rename="androidPackageName")] pub android_package_name: Option<String>, /// Link to open on Android if the app is not installed. #[serde(rename="androidFallbackLink")] pub android_fallback_link: Option<String>, /// If specified, this overrides the ‘link’ parameter on Android. #[serde(rename="androidLink")] pub android_link: Option<String>, /// Minimum version code for the Android app. If the installed app’s version /// code is lower, then the user is taken to the Play Store. #[serde(rename="androidMinPackageVersionCode")] pub android_min_package_version_code: Option<String>, } impl Part for AndroidInfo {} /// Request to create a short Dynamic Link. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [create short links](struct.ShortLinkCreateCall.html) (request) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct CreateShortDynamicLinkRequest { /// Information about the Dynamic Link to be shortened. /// [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). #[serde(rename="dynamicLinkInfo")] pub dynamic_link_info: Option<DynamicLinkInfo>, /// Google SDK version. Version takes the form "$major.$minor.$patch" #[serde(rename="sdkVersion")] pub sdk_version: Option<String>, /// Full long Dynamic Link URL with desired query parameters specified. /// For example, /// "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", /// [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). #[serde(rename="longDynamicLink")] pub long_dynamic_link: Option<String>, /// Short Dynamic Link suffix. Optional. pub suffix: Option<Suffix>, } impl RequestValue for CreateShortDynamicLinkRequest {} /// Dynamic Link event stat. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct DynamicLinkEventStat { /// The number of times this event occurred. pub count: Option<String>, /// Requested platform. pub platform: Option<String>, /// Link event. pub event: Option<String>, } impl Part for DynamicLinkEventStat {} /// Request for iSDK to execute strong match flow for post-install attribution. /// This is meant for iOS requests only. Requests from other platforms will /// not be honored. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [install attribution](struct.MethodInstallAttributionCall.html) (request) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct GetIosPostInstallAttributionRequest { /// Strong match page information. Disambiguates between default UI and /// custom page to present when strong match succeeds/fails to find cookie. #[serde(rename="visualStyle")] pub visual_style: Option<String>, /// Google SDK version. Version takes the form "$major.$minor.$patch" #[serde(rename="sdkVersion")] pub sdk_version: Option<String>, /// App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). /// This is a client signal for a more accurate weak match. #[serde(rename="appInstallationTime")] pub app_installation_time: Option<String>, /// Possible unique matched link that server need to check before performing /// fingerprint match. If passed link is short server need to expand the link. /// If link is long server need to vslidate the link. #[serde(rename="uniqueMatchLinkToCheck")] pub unique_match_link_to_check: Option<String>, /// App post install attribution retrieval information. Disambiguates /// mechanism (iSDK or developer invoked) to retrieve payload from /// clicked link. #[serde(rename="retrievalMethod")] pub retrieval_method: Option<String>, /// Device information. pub device: Option<DeviceInfo>, /// APP bundle ID. #[serde(rename="bundleId")] pub bundle_id: Option<String>, /// iOS version, ie: 9.3.5. /// Consider adding "build". #[serde(rename="iosVersion")] pub ios_version: Option<String>, } impl RequestValue for GetIosPostInstallAttributionRequest {} /// Information about a Dynamic Link. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct DynamicLinkInfo { /// Information of navigation behavior of a Firebase Dynamic Links. #[serde(rename="navigationInfo")] pub navigation_info: Option<NavigationInfo>, /// Parameters used for tracking. See all tracking parameters in the /// [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). #[serde(rename="analyticsInfo")] pub analytics_info: Option<AnalyticsInfo>, /// iOS related information. See iOS related parameters in the /// [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). #[serde(rename="iosInfo")] pub ios_info: Option<IosInfo>, /// Android related information. See Android related parameters in the /// [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). #[serde(rename="androidInfo")] pub android_info: Option<AndroidInfo>, /// Parameters for social meta tag params. /// Used to set meta tag data for link previews on social sites. #[serde(rename="socialMetaTagInfo")] pub social_meta_tag_info: Option<SocialMetaTagInfo>, /// E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps /// More examples can be found in description of getNormalizedUriPrefix in /// j/c/g/firebase/dynamiclinks/uri/DdlDomain.java #[serde(rename="domainUriPrefix")] pub domain_uri_prefix: Option<String>, /// The link your app will open, You can specify any URL your app can handle. /// This link must be a well-formatted URL, be properly URL-encoded, and use /// the HTTP or HTTPS scheme. See 'link' parameters in the /// [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). /// /// Required. pub link: Option<String>, /// Desktop related information. See desktop related parameters in the /// [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). #[serde(rename="desktopInfo")] pub desktop_info: Option<DesktopInfo>, /// Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl /// [Learn more](https://firebase.google.com/docs/dynamic-links/android/receive) /// on how to set up Dynamic Link domain associated with your Firebase project. /// /// Required. #[serde(rename="dynamicLinkDomain")] pub dynamic_link_domain: Option<String>, } impl Part for DynamicLinkInfo {} /// Response to create a short Dynamic Link. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [create managed short links](struct.ManagedShortLinkCreateCall.html) (response) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct CreateManagedShortLinkResponse { /// Information about potential warnings on link creation. pub warning: Option<Vec<DynamicLinkWarning>>, /// Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz #[serde(rename="managedShortLink")] pub managed_short_link: Option<ManagedShortLink>, /// Preview link to show the link flow chart. (debug info.) #[serde(rename="previewLink")] pub preview_link: Option<String>, } impl ResponseResult for CreateManagedShortLinkResponse {} /// Tracking parameters supported by Dynamic Link. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct AnalyticsInfo { /// Google Play Campaign Measurements. #[serde(rename="googlePlayAnalytics")] pub google_play_analytics: Option<GooglePlayAnalytics>, /// iTunes Connect App Analytics. #[serde(rename="itunesConnectAnalytics")] pub itunes_connect_analytics: Option<ITunesConnectAnalytics>, } impl Part for AnalyticsInfo {} /// Analytics stats of a Dynamic Link for a given timeframe. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [get link stats](struct.MethodGetLinkStatCall.html) (response) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct DynamicLinkStats { /// Dynamic Link event stats. #[serde(rename="linkEventStats")] pub link_event_stats: Option<Vec<DynamicLinkEventStat>>, } impl ResponseResult for DynamicLinkStats {} /// Short Dynamic Link suffix. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct Suffix { /// Suffix option. pub option: Option<String>, /// Only applies to Option.CUSTOM. #[serde(rename="customSuffix")] pub custom_suffix: Option<String>, } impl Part for Suffix {} /// Dynamic Links warning messages. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct DynamicLinkWarning { /// The document describing the warning, and helps resolve. #[serde(rename="warningDocumentLink")] pub warning_document_link: Option<String>, /// The warning code. #[serde(rename="warningCode")] pub warning_code: Option<String>, /// The warning message to help developers improve their requests. #[serde(rename="warningMessage")] pub warning_message: Option<String>, } impl Part for DynamicLinkWarning {} /// iOS related attributes to the Dynamic Link.. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct IosInfo { /// Custom (destination) scheme to use for iOS. By default, we’ll use the /// bundle ID as the custom scheme. Developer can override this behavior using /// this param. #[serde(rename="iosCustomScheme")] pub ios_custom_scheme: Option<String>, /// Link to open on iOS if the app is not installed. #[serde(rename="iosFallbackLink")] pub ios_fallback_link: Option<String>, /// iOS bundle ID of the app. #[serde(rename="iosBundleId")] pub ios_bundle_id: Option<String>, /// If specified, this overrides the ios_fallback_link value on iPads. #[serde(rename="iosIpadFallbackLink")] pub ios_ipad_fallback_link: Option<String>, /// iPad bundle ID of the app. #[serde(rename="iosIpadBundleId")] pub ios_ipad_bundle_id: Option<String>, /// iOS App Store ID. #[serde(rename="iosAppStoreId")] pub ios_app_store_id: Option<String>, } impl Part for IosInfo {} /// Parameters for social meta tag params. /// Used to set meta tag data for link previews on social sites. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct SocialMetaTagInfo { /// Title to be displayed. Optional. #[serde(rename="socialTitle")] pub social_title: Option<String>, /// A short description of the link. Optional. #[serde(rename="socialDescription")] pub social_description: Option<String>, /// An image url string. Optional. #[serde(rename="socialImageLink")] pub social_image_link: Option<String>, } impl Part for SocialMetaTagInfo {} /// Signals associated with the device making the request. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct DeviceInfo { /// Device language code setting. #[serde(rename="languageCode")] pub language_code: Option<String>, /// Device language code raw setting. /// iOS does returns language code in different format than iOS WebView. /// For example WebView returns en_US, but iOS returns en-US. /// Field below will return raw value returned by iOS. #[serde(rename="languageCodeRaw")] pub language_code_raw: Option<String>, /// Device model name. #[serde(rename="deviceModelName")] pub device_model_name: Option<String>, /// Device language code setting obtained by executing JavaScript code in /// WebView. #[serde(rename="languageCodeFromWebview")] pub language_code_from_webview: Option<String>, /// Device display resolution height. #[serde(rename="screenResolutionHeight")] pub screen_resolution_height: Option<String>, /// Device timezone setting. pub timezone: Option<String>, /// Device display resolution width. #[serde(rename="screenResolutionWidth")] pub screen_resolution_width: Option<String>, } impl Part for DeviceInfo {} /// Parameters for iTunes Connect App Analytics. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ITunesConnectAnalytics { /// iTune media types, including music, podcasts, audiobooks and so on. pub mt: Option<String>, /// Affiliate token used to create affiliate-coded links. pub at: Option<String>, /// Provider token that enables analytics for Dynamic Links from within iTunes /// Connect. pub pt: Option<String>, /// Campaign text that developers can optionally add to any link in order to /// track sales from a specific marketing campaign. pub ct: Option<String>, } impl Part for ITunesConnectAnalytics {} /// Request to create a managed Short Dynamic Link. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [create managed short links](struct.ManagedShortLinkCreateCall.html) (request) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct CreateManagedShortLinkRequest { /// Information about the Dynamic Link to be shortened. /// [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). #[serde(rename="dynamicLinkInfo")] pub dynamic_link_info: Option<DynamicLinkInfo>, /// Google SDK version. Version takes the form "$major.$minor.$patch" #[serde(rename="sdkVersion")] pub sdk_version: Option<String>, /// Full long Dynamic Link URL with desired query parameters specified. /// For example, /// "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", /// [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). #[serde(rename="longDynamicLink")] pub long_dynamic_link: Option<String>, /// Short Dynamic Link suffix. Optional. pub suffix: Option<Suffix>, /// Link name to associate with the link. It's used for marketer to identify /// manually-created links in the Firebase console /// (https://console.firebase.google.com/). /// Links must be named to be tracked. pub name: Option<String>, } impl RequestValue for CreateManagedShortLinkRequest {} /// Response for iSDK to get reopen attribution for app universal link open /// deeplinking. This endpoint is meant for only iOS requests. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [reopen attribution](struct.MethodReopenAttributionCall.html) (response) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct GetIosReopenAttributionResponse { /// Scion medium value to be propagated by iSDK to Scion at app-reopen. #[serde(rename="utmMedium")] pub utm_medium: Option<String>, /// Scion source value to be propagated by iSDK to Scion at app-reopen. #[serde(rename="utmSource")] pub utm_source: Option<String>, /// The entire FDL, expanded from a short link. It is the same as the /// requested_link, if it is long. #[serde(rename="resolvedLink")] pub resolved_link: Option<String>, /// Scion campaign value to be propagated by iSDK to Scion at app-reopen. #[serde(rename="utmCampaign")] pub utm_campaign: Option<String>, /// The deep-link attributed the app universal link open. For both regular /// FDL links and invite FDL links. #[serde(rename="deepLink")] pub deep_link: Option<String>, /// Optional invitation ID, for only invite typed requested FDL links. #[serde(rename="invitationId")] pub invitation_id: Option<String>, } impl ResponseResult for GetIosReopenAttributionResponse {} /// Parameters for Google Play Campaign Measurements. /// [Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params) /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct GooglePlayAnalytics { /// Campaign medium; used to identify a medium such as email or cost-per-click. #[serde(rename="utmMedium")] pub utm_medium: Option<String>, /// Campaign content; used for A/B testing and content-targeted ads to /// differentiate ads or links that point to the same URL. #[serde(rename="utmContent")] pub utm_content: Option<String>, /// Campaign source; used to identify a search engine, newsletter, or other /// source. #[serde(rename="utmSource")] pub utm_source: Option<String>, /// [AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en); /// used to measure Google AdWords ads. This value is generated dynamically /// and should never be modified. pub gclid: Option<String>, /// Campaign name; used for keyword analysis to identify a specific product /// promotion or strategic campaign. #[serde(rename="utmCampaign")] pub utm_campaign: Option<String>, /// Campaign term; used with paid search to supply the keywords for ads. #[serde(rename="utmTerm")] pub utm_term: Option<String>, } impl Part for GooglePlayAnalytics {} /// Managed Short Link. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [create managed short links](struct.ManagedShortLinkCreateCall.html) (none) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ManagedShortLink { /// Full Dyamic Link info pub info: Option<DynamicLinkInfo>, /// Short durable link url, for example, "https://sample.app.goo.gl/xyz123". /// /// Required. pub link: Option<String>, /// Visibility status of link. pub visibility: Option<String>, /// Link name defined by the creator. /// /// Required. #[serde(rename="linkName")] pub link_name: Option<String>, /// Creation timestamp of the short link. #[serde(rename="creationTime")] pub creation_time: Option<String>, /// Attributes that have been flagged about this short url. #[serde(rename="flaggedAttribute")] pub flagged_attribute: Option<Vec<String>>, } impl Resource for ManagedShortLink {} /// Desktop related attributes to the Dynamic Link. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct DesktopInfo { /// Link to open on desktop. #[serde(rename="desktopFallbackLink")] pub desktop_fallback_link: Option<String>, } impl Part for DesktopInfo {} /// Response to create a short Dynamic Link. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [create short links](struct.ShortLinkCreateCall.html) (response) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct CreateShortDynamicLinkResponse { /// Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz #[serde(rename="shortLink")] pub short_link: Option<String>, /// Information about potential warnings on link creation. pub warning: Option<Vec<DynamicLinkWarning>>, /// Preview link to show the link flow chart. (debug info.) #[serde(rename="previewLink")] pub preview_link: Option<String>, } impl ResponseResult for CreateShortDynamicLinkResponse {} /// Request for iSDK to get reopen attribution for app universal link open /// deeplinking. This endpoint is meant for only iOS requests. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [reopen attribution](struct.MethodReopenAttributionCall.html) (request) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct GetIosReopenAttributionRequest { /// Google SDK version. Version takes the form "$major.$minor.$patch" #[serde(rename="sdkVersion")] pub sdk_version: Option<String>, /// FDL link to be verified from an app universal link open. /// The FDL link can be one of: /// 1) short FDL. /// e.g. <app_code>.page.link/<ddl_id>, or /// 2) long FDL. /// e.g. <app_code>.page.link/?{query params}, or /// 3) Invite FDL. /// e.g. <app_code>.page.link/i/<invite_id_or_alias> #[serde(rename="requestedLink")] pub requested_link: Option<String>, /// APP bundle ID. #[serde(rename="bundleId")] pub bundle_id: Option<String>, } impl RequestValue for GetIosReopenAttributionRequest {} // ################### // MethodBuilders ### // ################# /// A builder providing access to all methods supported on *shortLink* resources. /// It is not used directly, but through the `FirebaseDynamicLinks` hub. /// /// # Example /// /// Instantiate a resource builder /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate yup_oauth2 as oauth2; /// extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// /// # #[test] fn egal() { /// use std::default::Default; /// use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// let secret: ApplicationSecret = Default::default(); /// let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// <MemoryStorage as Default>::default(), None); /// let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders* /// // like `create(...)` /// // to build up your call. /// let rb = hub.short_links(); /// # } /// ``` pub struct ShortLinkMethods<'a, C, A> where C: 'a, A: 'a { hub: &'a FirebaseDynamicLinks<C, A>, } impl<'a, C, A> MethodsBuilder for ShortLinkMethods<'a, C, A> {} impl<'a, C, A> ShortLinkMethods<'a, C, A> { /// Create a builder to help you perform the following task: /// /// Creates a short Dynamic Link given either a valid long Dynamic Link or /// details such as Dynamic Link domain, Android and iOS app information. /// The created short Dynamic Link will not expire. /// /// Repeated calls with the same long Dynamic Link or Dynamic Link information /// will produce the same short Dynamic Link. /// /// The Dynamic Link domain in the request must be owned by requester's /// Firebase project. /// /// # Arguments /// /// * `request` - No description provided. pub fn create(&self, request: CreateShortDynamicLinkRequest) -> ShortLinkCreateCall<'a, C, A> { ShortLinkCreateCall { hub: self.hub, _request: request, _delegate: Default::default(), _scopes: Default::default(), _additional_params: Default::default(), } } } /// A builder providing access to all free methods, which are not associated with a particular resource. /// It is not used directly, but through the `FirebaseDynamicLinks` hub. /// /// # Example /// /// Instantiate a resource builder /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate yup_oauth2 as oauth2; /// extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// /// # #[test] fn egal() { /// use std::default::Default; /// use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// let secret: ApplicationSecret = Default::default(); /// let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// <MemoryStorage as Default>::default(), None); /// let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders* /// // like `get_link_stats(...)`, `install_attribution(...)` and `reopen_attribution(...)` /// // to build up your call. /// let rb = hub.methods(); /// # } /// ``` pub struct MethodMethods<'a, C, A> where C: 'a, A: 'a { hub: &'a FirebaseDynamicLinks<C, A>, } impl<'a, C, A> MethodsBuilder for MethodMethods<'a, C, A> {} impl<'a, C, A> MethodMethods<'a, C, A> { /// Create a builder to help you perform the following task: /// /// Fetches analytics stats of a short Dynamic Link for a given /// duration. Metrics include number of clicks, redirects, installs, /// app first opens, and app reopens. /// /// # Arguments /// /// * `dynamicLink` - Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz pub fn get_link_stats(&self, dynamic_link: &str) -> MethodGetLinkStatCall<'a, C, A> { MethodGetLinkStatCall { hub: self.hub, _dynamic_link: dynamic_link.to_string(), _sdk_version: Default::default(), _duration_days: Default::default(), _delegate: Default::default(), _scopes: Default::default(), _additional_params: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Get iOS strong/weak-match info for post-install attribution. /// /// # Arguments /// /// * `request` - No description provided. pub fn install_attribution(&self, request: GetIosPostInstallAttributionRequest) -> MethodInstallAttributionCall<'a, C, A> { MethodInstallAttributionCall { hub: self.hub, _request: request, _delegate: Default::default(), _scopes: Default::default(), _additional_params: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Get iOS reopen attribution for app universal link open deeplinking. /// /// # Arguments /// /// * `request` - No description provided. pub fn reopen_attribution(&self, request: GetIosReopenAttributionRequest) -> MethodReopenAttributionCall<'a, C, A> { MethodReopenAttributionCall { hub: self.hub, _request: request, _delegate: Default::default(), _scopes: Default::default(), _additional_params: Default::default(), } } } /// A builder providing access to all methods supported on *managedShortLink* resources. /// It is not used directly, but through the `FirebaseDynamicLinks` hub. /// /// # Example /// /// Instantiate a resource builder /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate yup_oauth2 as oauth2; /// extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// /// # #[test] fn egal() { /// use std::default::Default; /// use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// let secret: ApplicationSecret = Default::default(); /// let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// <MemoryStorage as Default>::default(), None); /// let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders* /// // like `create(...)` /// // to build up your call. /// let rb = hub.managed_short_links(); /// # } /// ``` pub struct ManagedShortLinkMethods<'a, C, A> where C: 'a, A: 'a { hub: &'a FirebaseDynamicLinks<C, A>, } impl<'a, C, A> MethodsBuilder for ManagedShortLinkMethods<'a, C, A> {} impl<'a, C, A> ManagedShortLinkMethods<'a, C, A> { /// Create a builder to help you perform the following task: /// /// Creates a managed short Dynamic Link given either a valid long Dynamic Link /// or details such as Dynamic Link domain, Android and iOS app information. /// The created short Dynamic Link will not expire. /// /// This differs from CreateShortDynamicLink in the following ways: /// - The request will also contain a name for the link (non unique name /// for the front end). /// - The response must be authenticated with an auth token (generated with /// the admin service account). /// - The link will appear in the FDL list of links in the console front end. /// /// The Dynamic Link domain in the request must be owned by requester's /// Firebase project. /// /// # Arguments /// /// * `request` - No description provided. pub fn create(&self, request: CreateManagedShortLinkRequest) -> ManagedShortLinkCreateCall<'a, C, A> { ManagedShortLinkCreateCall { hub: self.hub, _request: request, _delegate: Default::default(), _scopes: Default::default(), _additional_params: Default::default(), } } } // ################### // CallBuilders ### // ################# /// Creates a short Dynamic Link given either a valid long Dynamic Link or /// details such as Dynamic Link domain, Android and iOS app information. /// The created short Dynamic Link will not expire. /// /// Repeated calls with the same long Dynamic Link or Dynamic Link information /// will produce the same short Dynamic Link. /// /// The Dynamic Link domain in the request must be owned by requester's /// Firebase project. /// /// A builder for the *create* method supported by a *shortLink* resource. /// It is not used directly, but through a `ShortLinkMethods` instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate yup_oauth2 as oauth2; /// # extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// use firebasedynamiclinks1::CreateShortDynamicLinkRequest; /// # #[test] fn egal() { /// # use std::default::Default; /// # use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// # use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// # let secret: ApplicationSecret = Default::default(); /// # let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// # hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// # <MemoryStorage as Default>::default(), None); /// # let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // As the method needs a request, you would usually fill it with the desired information /// // into the respective structure. Some of the parts shown here might not be applicable ! /// // Values shown here are possibly random and not representative ! /// let mut req = CreateShortDynamicLinkRequest::default(); /// /// // You can configure optional parameters by calling the respective setters at will, and /// // execute the final call using `doit()`. /// // Values shown here are possibly random and not representative ! /// let result = hub.short_links().create(req) /// .doit(); /// # } /// ``` pub struct ShortLinkCreateCall<'a, C, A> where C: 'a, A: 'a { hub: &'a FirebaseDynamicLinks<C, A>, _request: CreateShortDynamicLinkRequest, _delegate: Option<&'a mut Delegate>, _additional_params: HashMap<String, String>, _scopes: BTreeMap<String, ()> } impl<'a, C, A> CallBuilder for ShortLinkCreateCall<'a, C, A> {} impl<'a, C, A> ShortLinkCreateCall<'a, C, A> where C: BorrowMut<hyper::Client>, A: oauth2::GetToken { /// Perform the operation you have build so far. pub fn doit(mut self) -> Result<(hyper::client::Response, CreateShortDynamicLinkResponse)> { use std::io::{Read, Seek}; use hyper::header::{ContentType, ContentLength, Authorization, Bearer, UserAgent, Location}; let mut dd = DefaultDelegate; let mut dlg: &mut Delegate = match self._delegate { Some(d) => d, None => &mut dd }; dlg.begin(MethodInfo { id: "firebasedynamiclinks.shortLinks.create", http_method: hyper::method::Method::Post }); let mut params: Vec<(&str, String)> = Vec::with_capacity(3 + self._additional_params.len()); for &field in ["alt"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(Error::FieldClash(field)); } } for (name, value) in self._additional_params.iter() { params.push((&name, value.clone())); } params.push(("alt", "json".to_string())); let mut url = self.hub._base_url.clone() + "v1/shortLinks"; if self._scopes.len() == 0 { self._scopes.insert(Scope::Firebase.as_ref().to_string(), ()); } if params.len() > 0 { url.push('?'); url.push_str(&url::form_urlencoded::serialize(params)); } let mut json_mime_type = mime::Mime(mime::TopLevel::Application, mime::SubLevel::Json, Default::default()); let mut request_value_reader = { let mut value = json::value::to_value(&self._request).expect("serde to work"); remove_json_null_values(&mut value); let mut dst = io::Cursor::new(Vec::with_capacity(128)); json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader.seek(io::SeekFrom::End(0)).unwrap(); request_value_reader.seek(io::SeekFrom::Start(0)).unwrap(); loop { let token = match self.hub.auth.borrow_mut().token(self._scopes.keys()) { Ok(token) => token, Err(err) => { match dlg.token(&*err) { Some(token) => token, None => { dlg.finished(false); return Err(Error::MissingToken(err)) } } } }; let auth_header = Authorization(Bearer { token: token.access_token }); request_value_reader.seek(io::SeekFrom::Start(0)).unwrap(); let mut req_result = { let mut client = &mut *self.hub.client.borrow_mut(); let mut req = client.borrow_mut().request(hyper::method::Method::Post, &url) .header(UserAgent(self.hub._user_agent.clone())) .header(auth_header.clone()) .header(ContentType(json_mime_type.clone())) .header(ContentLength(request_size as u64)) .body(&mut request_value_reader); dlg.pre_request(); req.send() }; match req_result { Err(err) => { if let oauth2::Retry::After(d) = dlg.http_error(&err) { sleep(d); continue; } dlg.finished(false); return Err(Error::HttpError(err)) } Ok(mut res) => { if !res.status.is_success() { let mut json_err = String::new(); res.read_to_string(&mut json_err).unwrap(); if let oauth2::Retry::After(d) = dlg.http_failure(&res, json::from_str(&json_err).ok(), json::from_str(&json_err).ok()) { sleep(d); continue; } dlg.finished(false); return match json::from_str::<ErrorResponse>(&json_err){ Err(_) => Err(Error::Failure(res)), Ok(serr) => Err(Error::BadRequest(serr)) } } let result_value = { let mut json_response = String::new(); res.read_to_string(&mut json_response).unwrap(); match json::from_str(&json_response) { Ok(decoded) => (res, decoded), Err(err) => { dlg.response_json_decode_error(&json_response, &err); return Err(Error::JsonDecodeError(json_response, err)); } } }; dlg.finished(true); return Ok(result_value) } } } } /// /// Sets the *request* property to the given value. /// /// Even though the property as already been set when instantiating this call, /// we provide this method for API completeness. pub fn request(mut self, new_value: CreateShortDynamicLinkRequest) -> ShortLinkCreateCall<'a, C, A> { self._request = new_value; self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// It should be used to handle progress information, and to implement a certain level of resilience. /// /// Sets the *delegate* property to the given value. pub fn delegate(mut self, new_value: &'a mut Delegate) -> ShortLinkCreateCall<'a, C, A> { self._delegate = Some(new_value); self } /// Set any additional parameter of the query string used in the request. /// It should be used to set parameters which are not yet available through their own /// setters. /// /// Please note that this method must not be used to set any of the known paramters /// which have their own setter method. If done anyway, the request will fail. /// /// # Additional Parameters /// /// * *upload_protocol* (query-string) - Upload protocol for media (e.g. "raw", "multipart"). /// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks. /// * *access_token* (query-string) - OAuth access token. /// * *uploadType* (query-string) - Legacy upload protocol for media (e.g. "media", "multipart"). /// * *quotaUser* (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. /// * *callback* (query-string) - JSONP /// * *oauth_token* (query-string) - OAuth 2.0 token for the current user. /// * *key* (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. /// * *fields* (query-string) - Selector specifying which fields to include in a partial response. /// * *alt* (query-string) - Data format for response. /// * *$.xgafv* (query-string) - V1 error format. pub fn param<T>(mut self, name: T, value: T) -> ShortLinkCreateCall<'a, C, A> where T: AsRef<str> { self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// Identifies the authorization scope for the method you are building. /// /// Use this method to actively specify which scope should be used, instead the default `Scope` variant /// `Scope::Firebase`. /// /// The `scope` will be added to a set of scopes. This is important as one can maintain access /// tokens for more than one scope. /// If `None` is specified, then all scopes will be removed and no default scope will be used either. /// In that case, you have to specify your API-key using the `key` parameter (see the `param()` /// function for details). /// /// Usually there is more than one suitable scope to authorize an operation, some of which may /// encompass more rights than others. For example, for listing resources, a *read-only* scope will be /// sufficient, a read-write scope will do as well. pub fn add_scope<T, S>(mut self, scope: T) -> ShortLinkCreateCall<'a, C, A> where T: Into<Option<S>>, S: AsRef<str> { match scope.into() { Some(scope) => self._scopes.insert(scope.as_ref().to_string(), ()), None => None, }; self } } /// Fetches analytics stats of a short Dynamic Link for a given /// duration. Metrics include number of clicks, redirects, installs, /// app first opens, and app reopens. /// /// A builder for the *getLinkStats* method. /// It is not used directly, but through a `MethodMethods` instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate yup_oauth2 as oauth2; /// # extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// # #[test] fn egal() { /// # use std::default::Default; /// # use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// # use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// # let secret: ApplicationSecret = Default::default(); /// # let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// # hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// # <MemoryStorage as Default>::default(), None); /// # let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // You can configure optional parameters by calling the respective setters at will, and /// // execute the final call using `doit()`. /// // Values shown here are possibly random and not representative ! /// let result = hub.methods().get_link_stats("dynamicLink") /// .sdk_version("sit") /// .duration_days("Stet") /// .doit(); /// # } /// ``` pub struct MethodGetLinkStatCall<'a, C, A> where C: 'a, A: 'a { hub: &'a FirebaseDynamicLinks<C, A>, _dynamic_link: String, _sdk_version: Option<String>, _duration_days: Option<String>, _delegate: Option<&'a mut Delegate>, _additional_params: HashMap<String, String>, _scopes: BTreeMap<String, ()> } impl<'a, C, A> CallBuilder for MethodGetLinkStatCall<'a, C, A> {} impl<'a, C, A> MethodGetLinkStatCall<'a, C, A> where C: BorrowMut<hyper::Client>, A: oauth2::GetToken { /// Perform the operation you have build so far. pub fn doit(mut self) -> Result<(hyper::client::Response, DynamicLinkStats)> { use std::io::{Read, Seek}; use hyper::header::{ContentType, ContentLength, Authorization, Bearer, UserAgent, Location}; let mut dd = DefaultDelegate; let mut dlg: &mut Delegate = match self._delegate { Some(d) => d, None => &mut dd }; dlg.begin(MethodInfo { id: "firebasedynamiclinks.getLinkStats", http_method: hyper::method::Method::Get }); let mut params: Vec<(&str, String)> = Vec::with_capacity(5 + self._additional_params.len()); params.push(("dynamicLink", self._dynamic_link.to_string())); if let Some(value) = self._sdk_version { params.push(("sdkVersion", value.to_string())); } if let Some(value) = self._duration_days { params.push(("durationDays", value.to_string())); } for &field in ["alt", "dynamicLink", "sdkVersion", "durationDays"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(Error::FieldClash(field)); } } for (name, value) in self._additional_params.iter() { params.push((&name, value.clone())); } params.push(("alt", "json".to_string())); let mut url = self.hub._base_url.clone() + "v1/{dynamicLink}/linkStats"; if self._scopes.len() == 0 { self._scopes.insert(Scope::Firebase.as_ref().to_string(), ()); } for &(find_this, param_name) in [("{dynamicLink}", "dynamicLink")].iter() { let mut replace_with: Option<&str> = None; for &(name, ref value) in params.iter() { if name == param_name { replace_with = Some(value); break; } } url = url.replace(find_this, replace_with.expect("to find substitution value in params")); } { let mut indices_for_removal: Vec<usize> = Vec::with_capacity(1); for param_name in ["dynamicLink"].iter() { if let Some(index) = params.iter().position(|t| &t.0 == param_name) { indices_for_removal.push(index); } } for &index in indices_for_removal.iter() { params.remove(index); } } if params.len() > 0 { url.push('?'); url.push_str(&url::form_urlencoded::serialize(params)); } loop { let token = match self.hub.auth.borrow_mut().token(self._scopes.keys()) { Ok(token) => token, Err(err) => { match dlg.token(&*err) { Some(token) => token, None => { dlg.finished(false); return Err(Error::MissingToken(err)) } } } }; let auth_header = Authorization(Bearer { token: token.access_token }); let mut req_result = { let mut client = &mut *self.hub.client.borrow_mut(); let mut req = client.borrow_mut().request(hyper::method::Method::Get, &url) .header(UserAgent(self.hub._user_agent.clone())) .header(auth_header.clone()); dlg.pre_request(); req.send() }; match req_result { Err(err) => { if let oauth2::Retry::After(d) = dlg.http_error(&err) { sleep(d); continue; } dlg.finished(false); return Err(Error::HttpError(err)) } Ok(mut res) => { if !res.status.is_success() { let mut json_err = String::new(); res.read_to_string(&mut json_err).unwrap(); if let oauth2::Retry::After(d) = dlg.http_failure(&res, json::from_str(&json_err).ok(), json::from_str(&json_err).ok()) { sleep(d); continue; } dlg.finished(false); return match json::from_str::<ErrorResponse>(&json_err){ Err(_) => Err(Error::Failure(res)), Ok(serr) => Err(Error::BadRequest(serr)) } } let result_value = { let mut json_response = String::new(); res.read_to_string(&mut json_response).unwrap(); match json::from_str(&json_response) { Ok(decoded) => (res, decoded), Err(err) => { dlg.response_json_decode_error(&json_response, &err); return Err(Error::JsonDecodeError(json_response, err)); } } }; dlg.finished(true); return Ok(result_value) } } } } /// Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz /// /// Sets the *dynamic link* path property to the given value. /// /// Even though the property as already been set when instantiating this call, /// we provide this method for API completeness. pub fn dynamic_link(mut self, new_value: &str) -> MethodGetLinkStatCall<'a, C, A> { self._dynamic_link = new_value.to_string(); self } /// Google SDK version. Version takes the form "$major.$minor.$patch" /// /// Sets the *sdk version* query property to the given value. pub fn sdk_version(mut self, new_value: &str) -> MethodGetLinkStatCall<'a, C, A> { self._sdk_version = Some(new_value.to_string()); self } /// The span of time requested in days. /// /// Sets the *duration days* query property to the given value. pub fn duration_days(mut self, new_value: &str) -> MethodGetLinkStatCall<'a, C, A> { self._duration_days = Some(new_value.to_string()); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// It should be used to handle progress information, and to implement a certain level of resilience. /// /// Sets the *delegate* property to the given value. pub fn delegate(mut self, new_value: &'a mut Delegate) -> MethodGetLinkStatCall<'a, C, A> { self._delegate = Some(new_value); self } /// Set any additional parameter of the query string used in the request. /// It should be used to set parameters which are not yet available through their own /// setters. /// /// Please note that this method must not be used to set any of the known paramters /// which have their own setter method. If done anyway, the request will fail. /// /// # Additional Parameters /// /// * *upload_protocol* (query-string) - Upload protocol for media (e.g. "raw", "multipart"). /// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks. /// * *access_token* (query-string) - OAuth access token. /// * *uploadType* (query-string) - Legacy upload protocol for media (e.g. "media", "multipart"). /// * *quotaUser* (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. /// * *callback* (query-string) - JSONP /// * *oauth_token* (query-string) - OAuth 2.0 token for the current user. /// * *key* (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. /// * *fields* (query-string) - Selector specifying which fields to include in a partial response. /// * *alt* (query-string) - Data format for response. /// * *$.xgafv* (query-string) - V1 error format. pub fn param<T>(mut self, name: T, value: T) -> MethodGetLinkStatCall<'a, C, A> where T: AsRef<str> { self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// Identifies the authorization scope for the method you are building. /// /// Use this method to actively specify which scope should be used, instead the default `Scope` variant /// `Scope::Firebase`. /// /// The `scope` will be added to a set of scopes. This is important as one can maintain access /// tokens for more than one scope. /// If `None` is specified, then all scopes will be removed and no default scope will be used either. /// In that case, you have to specify your API-key using the `key` parameter (see the `param()` /// function for details). /// /// Usually there is more than one suitable scope to authorize an operation, some of which may /// encompass more rights than others. For example, for listing resources, a *read-only* scope will be /// sufficient, a read-write scope will do as well. pub fn add_scope<T, S>(mut self, scope: T) -> MethodGetLinkStatCall<'a, C, A> where T: Into<Option<S>>, S: AsRef<str> { match scope.into() { Some(scope) => self._scopes.insert(scope.as_ref().to_string(), ()), None => None, }; self } } /// Get iOS strong/weak-match info for post-install attribution. /// /// A builder for the *installAttribution* method. /// It is not used directly, but through a `MethodMethods` instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate yup_oauth2 as oauth2; /// # extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// use firebasedynamiclinks1::GetIosPostInstallAttributionRequest; /// # #[test] fn egal() { /// # use std::default::Default; /// # use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// # use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// # let secret: ApplicationSecret = Default::default(); /// # let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// # hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// # <MemoryStorage as Default>::default(), None); /// # let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // As the method needs a request, you would usually fill it with the desired information /// // into the respective structure. Some of the parts shown here might not be applicable ! /// // Values shown here are possibly random and not representative ! /// let mut req = GetIosPostInstallAttributionRequest::default(); /// /// // You can configure optional parameters by calling the respective setters at will, and /// // execute the final call using `doit()`. /// // Values shown here are possibly random and not representative ! /// let result = hub.methods().install_attribution(req) /// .doit(); /// # } /// ``` pub struct MethodInstallAttributionCall<'a, C, A> where C: 'a, A: 'a { hub: &'a FirebaseDynamicLinks<C, A>, _request: GetIosPostInstallAttributionRequest, _delegate: Option<&'a mut Delegate>, _additional_params: HashMap<String, String>, _scopes: BTreeMap<String, ()> } impl<'a, C, A> CallBuilder for MethodInstallAttributionCall<'a, C, A> {} impl<'a, C, A> MethodInstallAttributionCall<'a, C, A> where C: BorrowMut<hyper::Client>, A: oauth2::GetToken { /// Perform the operation you have build so far. pub fn doit(mut self) -> Result<(hyper::client::Response, GetIosPostInstallAttributionResponse)> { use std::io::{Read, Seek}; use hyper::header::{ContentType, ContentLength, Authorization, Bearer, UserAgent, Location}; let mut dd = DefaultDelegate; let mut dlg: &mut Delegate = match self._delegate { Some(d) => d, None => &mut dd }; dlg.begin(MethodInfo { id: "firebasedynamiclinks.installAttribution", http_method: hyper::method::Method::Post }); let mut params: Vec<(&str, String)> = Vec::with_capacity(3 + self._additional_params.len()); for &field in ["alt"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(Error::FieldClash(field)); } } for (name, value) in self._additional_params.iter() { params.push((&name, value.clone())); } params.push(("alt", "json".to_string())); let mut url = self.hub._base_url.clone() + "v1/installAttribution"; if self._scopes.len() == 0 { self._scopes.insert(Scope::Firebase.as_ref().to_string(), ()); } if params.len() > 0 { url.push('?'); url.push_str(&url::form_urlencoded::serialize(params)); } let mut json_mime_type = mime::Mime(mime::TopLevel::Application, mime::SubLevel::Json, Default::default()); let mut request_value_reader = { let mut value = json::value::to_value(&self._request).expect("serde to work"); remove_json_null_values(&mut value); let mut dst = io::Cursor::new(Vec::with_capacity(128)); json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader.seek(io::SeekFrom::End(0)).unwrap(); request_value_reader.seek(io::SeekFrom::Start(0)).unwrap(); loop { let token = match self.hub.auth.borrow_mut().token(self._scopes.keys()) { Ok(token) => token, Err(err) => { match dlg.token(&*err) { Some(token) => token, None => { dlg.finished(false); return Err(Error::MissingToken(err)) } } } }; let auth_header = Authorization(Bearer { token: token.access_token }); request_value_reader.seek(io::SeekFrom::Start(0)).unwrap(); let mut req_result = { let mut client = &mut *self.hub.client.borrow_mut(); let mut req = client.borrow_mut().request(hyper::method::Method::Post, &url) .header(UserAgent(self.hub._user_agent.clone())) .header(auth_header.clone()) .header(ContentType(json_mime_type.clone())) .header(ContentLength(request_size as u64)) .body(&mut request_value_reader); dlg.pre_request(); req.send() }; match req_result { Err(err) => { if let oauth2::Retry::After(d) = dlg.http_error(&err) { sleep(d); continue; } dlg.finished(false); return Err(Error::HttpError(err)) } Ok(mut res) => { if !res.status.is_success() { let mut json_err = String::new(); res.read_to_string(&mut json_err).unwrap(); if let oauth2::Retry::After(d) = dlg.http_failure(&res, json::from_str(&json_err).ok(), json::from_str(&json_err).ok()) { sleep(d); continue; } dlg.finished(false); return match json::from_str::<ErrorResponse>(&json_err){ Err(_) => Err(Error::Failure(res)), Ok(serr) => Err(Error::BadRequest(serr)) } } let result_value = { let mut json_response = String::new(); res.read_to_string(&mut json_response).unwrap(); match json::from_str(&json_response) { Ok(decoded) => (res, decoded), Err(err) => { dlg.response_json_decode_error(&json_response, &err); return Err(Error::JsonDecodeError(json_response, err)); } } }; dlg.finished(true); return Ok(result_value) } } } } /// /// Sets the *request* property to the given value. /// /// Even though the property as already been set when instantiating this call, /// we provide this method for API completeness. pub fn request(mut self, new_value: GetIosPostInstallAttributionRequest) -> MethodInstallAttributionCall<'a, C, A> { self._request = new_value; self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// It should be used to handle progress information, and to implement a certain level of resilience. /// /// Sets the *delegate* property to the given value. pub fn delegate(mut self, new_value: &'a mut Delegate) -> MethodInstallAttributionCall<'a, C, A> { self._delegate = Some(new_value); self } /// Set any additional parameter of the query string used in the request. /// It should be used to set parameters which are not yet available through their own /// setters. /// /// Please note that this method must not be used to set any of the known paramters /// which have their own setter method. If done anyway, the request will fail. /// /// # Additional Parameters /// /// * *upload_protocol* (query-string) - Upload protocol for media (e.g. "raw", "multipart"). /// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks. /// * *access_token* (query-string) - OAuth access token. /// * *uploadType* (query-string) - Legacy upload protocol for media (e.g. "media", "multipart"). /// * *quotaUser* (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. /// * *callback* (query-string) - JSONP /// * *oauth_token* (query-string) - OAuth 2.0 token for the current user. /// * *key* (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. /// * *fields* (query-string) - Selector specifying which fields to include in a partial response. /// * *alt* (query-string) - Data format for response. /// * *$.xgafv* (query-string) - V1 error format. pub fn param<T>(mut self, name: T, value: T) -> MethodInstallAttributionCall<'a, C, A> where T: AsRef<str> { self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// Identifies the authorization scope for the method you are building. /// /// Use this method to actively specify which scope should be used, instead the default `Scope` variant /// `Scope::Firebase`. /// /// The `scope` will be added to a set of scopes. This is important as one can maintain access /// tokens for more than one scope. /// If `None` is specified, then all scopes will be removed and no default scope will be used either. /// In that case, you have to specify your API-key using the `key` parameter (see the `param()` /// function for details). /// /// Usually there is more than one suitable scope to authorize an operation, some of which may /// encompass more rights than others. For example, for listing resources, a *read-only* scope will be /// sufficient, a read-write scope will do as well. pub fn add_scope<T, S>(mut self, scope: T) -> MethodInstallAttributionCall<'a, C, A> where T: Into<Option<S>>, S: AsRef<str> { match scope.into() { Some(scope) => self._scopes.insert(scope.as_ref().to_string(), ()), None => None, }; self } } /// Get iOS reopen attribution for app universal link open deeplinking. /// /// A builder for the *reopenAttribution* method. /// It is not used directly, but through a `MethodMethods` instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate yup_oauth2 as oauth2; /// # extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// use firebasedynamiclinks1::GetIosReopenAttributionRequest; /// # #[test] fn egal() { /// # use std::default::Default; /// # use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// # use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// # let secret: ApplicationSecret = Default::default(); /// # let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// # hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// # <MemoryStorage as Default>::default(), None); /// # let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // As the method needs a request, you would usually fill it with the desired information /// // into the respective structure. Some of the parts shown here might not be applicable ! /// // Values shown here are possibly random and not representative ! /// let mut req = GetIosReopenAttributionRequest::default(); /// /// // You can configure optional parameters by calling the respective setters at will, and /// // execute the final call using `doit()`. /// // Values shown here are possibly random and not representative ! /// let result = hub.methods().reopen_attribution(req) /// .doit(); /// # } /// ``` pub struct MethodReopenAttributionCall<'a, C, A> where C: 'a, A: 'a { hub: &'a FirebaseDynamicLinks<C, A>, _request: GetIosReopenAttributionRequest, _delegate: Option<&'a mut Delegate>, _additional_params: HashMap<String, String>, _scopes: BTreeMap<String, ()> } impl<'a, C, A> CallBuilder for MethodReopenAttributionCall<'a, C, A> {} impl<'a, C, A> MethodReopenAttributionCall<'a, C, A> where C: BorrowMut<hyper::Client>, A: oauth2::GetToken { /// Perform the operation you have build so far. pub fn doit(mut self) -> Result<(hyper::client::Response, GetIosReopenAttributionResponse)> { use std::io::{Read, Seek}; use hyper::header::{ContentType, ContentLength, Authorization, Bearer, UserAgent, Location}; let mut dd = DefaultDelegate; let mut dlg: &mut Delegate = match self._delegate { Some(d) => d, None => &mut dd }; dlg.begin(MethodInfo { id: "firebasedynamiclinks.reopenAttribution", http_method: hyper::method::Method::Post }); let mut params: Vec<(&str, String)> = Vec::with_capacity(3 + self._additional_params.len()); for &field in ["alt"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(Error::FieldClash(field)); } } for (name, value) in self._additional_params.iter() { params.push((&name, value.clone())); } params.push(("alt", "json".to_string())); let mut url = self.hub._base_url.clone() + "v1/reopenAttribution"; if self._scopes.len() == 0 { self._scopes.insert(Scope::Firebase.as_ref().to_string(), ()); } if params.len() > 0 { url.push('?'); url.push_str(&url::form_urlencoded::serialize(params)); } let mut json_mime_type = mime::Mime(mime::TopLevel::Application, mime::SubLevel::Json, Default::default()); let mut request_value_reader = { let mut value = json::value::to_value(&self._request).expect("serde to work"); remove_json_null_values(&mut value); let mut dst = io::Cursor::new(Vec::with_capacity(128)); json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader.seek(io::SeekFrom::End(0)).unwrap(); request_value_reader.seek(io::SeekFrom::Start(0)).unwrap(); loop { let token = match self.hub.auth.borrow_mut().token(self._scopes.keys()) { Ok(token) => token, Err(err) => { match dlg.token(&*err) { Some(token) => token, None => { dlg.finished(false); return Err(Error::MissingToken(err)) } } } }; let auth_header = Authorization(Bearer { token: token.access_token }); request_value_reader.seek(io::SeekFrom::Start(0)).unwrap(); let mut req_result = { let mut client = &mut *self.hub.client.borrow_mut(); let mut req = client.borrow_mut().request(hyper::method::Method::Post, &url) .header(UserAgent(self.hub._user_agent.clone())) .header(auth_header.clone()) .header(ContentType(json_mime_type.clone())) .header(ContentLength(request_size as u64)) .body(&mut request_value_reader); dlg.pre_request(); req.send() }; match req_result { Err(err) => { if let oauth2::Retry::After(d) = dlg.http_error(&err) { sleep(d); continue; } dlg.finished(false); return Err(Error::HttpError(err)) } Ok(mut res) => { if !res.status.is_success() { let mut json_err = String::new(); res.read_to_string(&mut json_err).unwrap(); if let oauth2::Retry::After(d) = dlg.http_failure(&res, json::from_str(&json_err).ok(), json::from_str(&json_err).ok()) { sleep(d); continue; } dlg.finished(false); return match json::from_str::<ErrorResponse>(&json_err){ Err(_) => Err(Error::Failure(res)), Ok(serr) => Err(Error::BadRequest(serr)) } } let result_value = { let mut json_response = String::new(); res.read_to_string(&mut json_response).unwrap(); match json::from_str(&json_response) { Ok(decoded) => (res, decoded), Err(err) => { dlg.response_json_decode_error(&json_response, &err); return Err(Error::JsonDecodeError(json_response, err)); } } }; dlg.finished(true); return Ok(result_value) } } } } /// /// Sets the *request* property to the given value. /// /// Even though the property as already been set when instantiating this call, /// we provide this method for API completeness. pub fn request(mut self, new_value: GetIosReopenAttributionRequest) -> MethodReopenAttributionCall<'a, C, A> { self._request = new_value; self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// It should be used to handle progress information, and to implement a certain level of resilience. /// /// Sets the *delegate* property to the given value. pub fn delegate(mut self, new_value: &'a mut Delegate) -> MethodReopenAttributionCall<'a, C, A> { self._delegate = Some(new_value); self } /// Set any additional parameter of the query string used in the request. /// It should be used to set parameters which are not yet available through their own /// setters. /// /// Please note that this method must not be used to set any of the known paramters /// which have their own setter method. If done anyway, the request will fail. /// /// # Additional Parameters /// /// * *upload_protocol* (query-string) - Upload protocol for media (e.g. "raw", "multipart"). /// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks. /// * *access_token* (query-string) - OAuth access token. /// * *uploadType* (query-string) - Legacy upload protocol for media (e.g. "media", "multipart"). /// * *quotaUser* (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. /// * *callback* (query-string) - JSONP /// * *oauth_token* (query-string) - OAuth 2.0 token for the current user. /// * *key* (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. /// * *fields* (query-string) - Selector specifying which fields to include in a partial response. /// * *alt* (query-string) - Data format for response. /// * *$.xgafv* (query-string) - V1 error format. pub fn param<T>(mut self, name: T, value: T) -> MethodReopenAttributionCall<'a, C, A> where T: AsRef<str> { self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// Identifies the authorization scope for the method you are building. /// /// Use this method to actively specify which scope should be used, instead the default `Scope` variant /// `Scope::Firebase`. /// /// The `scope` will be added to a set of scopes. This is important as one can maintain access /// tokens for more than one scope. /// If `None` is specified, then all scopes will be removed and no default scope will be used either. /// In that case, you have to specify your API-key using the `key` parameter (see the `param()` /// function for details). /// /// Usually there is more than one suitable scope to authorize an operation, some of which may /// encompass more rights than others. For example, for listing resources, a *read-only* scope will be /// sufficient, a read-write scope will do as well. pub fn add_scope<T, S>(mut self, scope: T) -> MethodReopenAttributionCall<'a, C, A> where T: Into<Option<S>>, S: AsRef<str> { match scope.into() { Some(scope) => self._scopes.insert(scope.as_ref().to_string(), ()), None => None, }; self } } /// Creates a managed short Dynamic Link given either a valid long Dynamic Link /// or details such as Dynamic Link domain, Android and iOS app information. /// The created short Dynamic Link will not expire. /// /// This differs from CreateShortDynamicLink in the following ways: /// - The request will also contain a name for the link (non unique name /// for the front end). /// - The response must be authenticated with an auth token (generated with /// the admin service account). /// - The link will appear in the FDL list of links in the console front end. /// /// The Dynamic Link domain in the request must be owned by requester's /// Firebase project. /// /// A builder for the *create* method supported by a *managedShortLink* resource. /// It is not used directly, but through a `ManagedShortLinkMethods` instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate yup_oauth2 as oauth2; /// # extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1; /// use firebasedynamiclinks1::CreateManagedShortLinkRequest; /// # #[test] fn egal() { /// # use std::default::Default; /// # use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// # use firebasedynamiclinks1::FirebaseDynamicLinks; /// /// # let secret: ApplicationSecret = Default::default(); /// # let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// # hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// # <MemoryStorage as Default>::default(), None); /// # let mut hub = FirebaseDynamicLinks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // As the method needs a request, you would usually fill it with the desired information /// // into the respective structure. Some of the parts shown here might not be applicable ! /// // Values shown here are possibly random and not representative ! /// let mut req = CreateManagedShortLinkRequest::default(); /// /// // You can configure optional parameters by calling the respective setters at will, and /// // execute the final call using `doit()`. /// // Values shown here are possibly random and not representative ! /// let result = hub.managed_short_links().create(req) /// .doit(); /// # } /// ``` pub struct ManagedShortLinkCreateCall<'a, C, A> where C: 'a, A: 'a { hub: &'a FirebaseDynamicLinks<C, A>, _request: CreateManagedShortLinkRequest, _delegate: Option<&'a mut Delegate>, _additional_params: HashMap<String, String>, _scopes: BTreeMap<String, ()> } impl<'a, C, A> CallBuilder for ManagedShortLinkCreateCall<'a, C, A> {} impl<'a, C, A> ManagedShortLinkCreateCall<'a, C, A> where C: BorrowMut<hyper::Client>, A: oauth2::GetToken { /// Perform the operation you have build so far. pub fn doit(mut self) -> Result<(hyper::client::Response, CreateManagedShortLinkResponse)> { use std::io::{Read, Seek}; use hyper::header::{ContentType, ContentLength, Authorization, Bearer, UserAgent, Location}; let mut dd = DefaultDelegate; let mut dlg: &mut Delegate = match self._delegate { Some(d) => d, None => &mut dd }; dlg.begin(MethodInfo { id: "firebasedynamiclinks.managedShortLinks.create", http_method: hyper::method::Method::Post }); let mut params: Vec<(&str, String)> = Vec::with_capacity(3 + self._additional_params.len()); for &field in ["alt"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(Error::FieldClash(field)); } } for (name, value) in self._additional_params.iter() { params.push((&name, value.clone())); } params.push(("alt", "json".to_string())); let mut url = self.hub._base_url.clone() + "v1/managedShortLinks:create"; if self._scopes.len() == 0 { self._scopes.insert(Scope::Firebase.as_ref().to_string(), ()); } if params.len() > 0 { url.push('?'); url.push_str(&url::form_urlencoded::serialize(params)); } let mut json_mime_type = mime::Mime(mime::TopLevel::Application, mime::SubLevel::Json, Default::default()); let mut request_value_reader = { let mut value = json::value::to_value(&self._request).expect("serde to work"); remove_json_null_values(&mut value); let mut dst = io::Cursor::new(Vec::with_capacity(128)); json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader.seek(io::SeekFrom::End(0)).unwrap(); request_value_reader.seek(io::SeekFrom::Start(0)).unwrap(); loop { let token = match self.hub.auth.borrow_mut().token(self._scopes.keys()) { Ok(token) => token, Err(err) => { match dlg.token(&*err) { Some(token) => token, None => { dlg.finished(false); return Err(Error::MissingToken(err)) } } } }; let auth_header = Authorization(Bearer { token: token.access_token }); request_value_reader.seek(io::SeekFrom::Start(0)).unwrap(); let mut req_result = { let mut client = &mut *self.hub.client.borrow_mut(); let mut req = client.borrow_mut().request(hyper::method::Method::Post, &url) .header(UserAgent(self.hub._user_agent.clone())) .header(auth_header.clone()) .header(ContentType(json_mime_type.clone())) .header(ContentLength(request_size as u64)) .body(&mut request_value_reader); dlg.pre_request(); req.send() }; match req_result { Err(err) => { if let oauth2::Retry::After(d) = dlg.http_error(&err) { sleep(d); continue; } dlg.finished(false); return Err(Error::HttpError(err)) } Ok(mut res) => { if !res.status.is_success() { let mut json_err = String::new(); res.read_to_string(&mut json_err).unwrap(); if let oauth2::Retry::After(d) = dlg.http_failure(&res, json::from_str(&json_err).ok(), json::from_str(&json_err).ok()) { sleep(d); continue; } dlg.finished(false); return match json::from_str::<ErrorResponse>(&json_err){ Err(_) => Err(Error::Failure(res)), Ok(serr) => Err(Error::BadRequest(serr)) } } let result_value = { let mut json_response = String::new(); res.read_to_string(&mut json_response).unwrap(); match json::from_str(&json_response) { Ok(decoded) => (res, decoded), Err(err) => { dlg.response_json_decode_error(&json_response, &err); return Err(Error::JsonDecodeError(json_response, err)); } } }; dlg.finished(true); return Ok(result_value) } } } } /// /// Sets the *request* property to the given value. /// /// Even though the property as already been set when instantiating this call, /// we provide this method for API completeness. pub fn request(mut self, new_value: CreateManagedShortLinkRequest) -> ManagedShortLinkCreateCall<'a, C, A> { self._request = new_value; self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// It should be used to handle progress information, and to implement a certain level of resilience. /// /// Sets the *delegate* property to the given value. pub fn delegate(mut self, new_value: &'a mut Delegate) -> ManagedShortLinkCreateCall<'a, C, A> { self._delegate = Some(new_value); self } /// Set any additional parameter of the query string used in the request. /// It should be used to set parameters which are not yet available through their own /// setters. /// /// Please note that this method must not be used to set any of the known paramters /// which have their own setter method. If done anyway, the request will fail. /// /// # Additional Parameters /// /// * *upload_protocol* (query-string) - Upload protocol for media (e.g. "raw", "multipart"). /// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks. /// * *access_token* (query-string) - OAuth access token. /// * *uploadType* (query-string) - Legacy upload protocol for media (e.g. "media", "multipart"). /// * *quotaUser* (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. /// * *callback* (query-string) - JSONP /// * *oauth_token* (query-string) - OAuth 2.0 token for the current user. /// * *key* (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. /// * *fields* (query-string) - Selector specifying which fields to include in a partial response. /// * *alt* (query-string) - Data format for response. /// * *$.xgafv* (query-string) - V1 error format. pub fn param<T>(mut self, name: T, value: T) -> ManagedShortLinkCreateCall<'a, C, A> where T: AsRef<str> { self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// Identifies the authorization scope for the method you are building. /// /// Use this method to actively specify which scope should be used, instead the default `Scope` variant /// `Scope::Firebase`. /// /// The `scope` will be added to a set of scopes. This is important as one can maintain access /// tokens for more than one scope. /// If `None` is specified, then all scopes will be removed and no default scope will be used either. /// In that case, you have to specify your API-key using the `key` parameter (see the `param()` /// function for details). /// /// Usually there is more than one suitable scope to authorize an operation, some of which may /// encompass more rights than others. For example, for listing resources, a *read-only* scope will be /// sufficient, a read-write scope will do as well. pub fn add_scope<T, S>(mut self, scope: T) -> ManagedShortLinkCreateCall<'a, C, A> where T: Into<Option<S>>, S: AsRef<str> { match scope.into() { Some(scope) => self._scopes.insert(scope.as_ref().to_string(), ()), None => None, }; self } }