From a31e1ec7010808eca9bd8ffdc22794e1e4b62c04 Mon Sep 17 00:00:00 2001 From: Jens Astrup Date: Thu, 28 Mar 2024 19:04:17 -0400 Subject: [PATCH 1/2] Add epic to docs --- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/Client.html | 4 ++-- docs/classes/Iteration.html | 14 +++++++------- docs/classes/IterationsService.html | 4 ++-- docs/classes/Member.html | 18 +++++++++--------- docs/classes/MembersService.html | 4 ++-- docs/classes/StoriesService.html | 6 +++--- docs/classes/Story.html | 28 ++++++++++++++-------------- docs/classes/Team.html | 14 +++++++------- docs/classes/TeamService.html | 4 ++-- docs/classes/Workflow.html | 18 +++++++++--------- docs/classes/WorkflowsService.html | 4 ++-- docs/coverage.svg | 4 ++-- docs/modules.html | 2 ++ src/index.ts | 6 ++++-- 16 files changed, 69 insertions(+), 65 deletions(-) diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 9121517..e9b887b 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE42QsQ6CMBBA/+VciYoyKKuTgxMmDsahwhEaWmraohLjvxslIFhbWO/de7nc8QEa7xpCSDAlJdPgwYXoDELgIikZqmmmOZt8aU6LBMLAXwfLefD0Wn/DKBYdPWZEKVSzev6ptLa/WHXMrUZJNBWFKbdolK8ilFcao6PTrLh6O+RnlGakng+b9jP63FWKtJAU7aU+HypV/wOVy9sj4ab2ng5Z1qM70NU4CJmnTNzMQEPG2Pbf/W6YtdMLdCSkIRcDAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE42QsQ6CMBRF/6WuREUZlNU4ODhh4mAcKjxCQ0tJW1Ri/HdFAoKlxfWenpOXnh5IwV0hH0UQ44Iq5KAcq+Q9MB4VFOQ0UYxOvjQlWYR8z117y7n3dFp/QwlkHT2kWEqQs3r/VFrbXaw65jYnoe5V65glAxBXEsKw3VBbZadAYEV4pida9JdvPkV7YuvtgV1A6JF6HzfNZ/S5rRQoLgiYS30+ViqHA6XNOwBmulatY5bx6A60NY5cpDHlNz3QkH9s89/9vtBr5xeEXHQBkwMAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index c1c4f8b..1d1ecf3 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61dXZPbuHL9Kyntq3auAH7P296PVLmSzX3wJnmYcm3JEm3zWiMpEjW7Lpf/ewogQXY3u0EQ0pPlUaMPiNNoNA4o8vvqcvrjunp++b762hz3q2ely/XquH2tV8+rvx2a+tiu1qvb5bB6Xu0O2+u1vv6l+/PTl/b1sFq7v66eV6sf68HLRqeDm4/ba/3fl4PPz0+jDfC3Xp23F9ODoSsjQqb0ALA7Ha/t5bZrTxcvCLYLBNK5Vul4MV/q7b6+XL04o00gBhqu65fTpd3d2l/OzX/U37xAE9MRr73uf26uP58vzdu2rRegt6dLU/uvb7SJub4/Tpevnw4m6nwY0CoGpWnry7ZtTkc/DDKLwWnr7asfwlnEeH+tXz/ORdtoE4oApvg7d/0TiOGb+yc6djU718c+LZ/uBCpkxnNw6LJ2l3rb1v/e1If9lAkKiG0jEbfnc8A4DlZ3Xdf+l2mGZy+qM4zEqo/7v3d5yIs0mkXjtE377bdv5wAoYBmJ9ul0OJz+qC/v5gMDm0bifb6cbucAMGB3D9KvZoxOx1BAZB6J2+znoKxFpPfD9mN9CLgcYHcPUhjOHShd6g+nibGPRg7HvB/N/jOD09tEIlzb7aUNyVDQMB6rnR02Z3QHxi0I5HYHyu28D1tBoGHsavVle/xc7wOXYWLM1MWntt619f7f+j80xy/1pWnr/Vyn9CYtyQCEXT3XjTjUbj0OW7Ufh3rdvs3Pjs7mQYj7+lDPX+dgFY8KK+JfbY6cgHZ/vr8WBn5cIfyzCu5837nldTGEDSmKJ0CBlSPCmS0b/Sj75rr9eKinFQEEAUYxGJ56EaIEFIt+HLFygyizZZsfg6mdoHdP4eT3e76cPjUH/wCNNjEIl9OM+94gxrdZ4/zOnUWMd3kFhAjzy58fZUEyiZ3R3tUVzerHLK0hCSakN9J+exF2yJo+5fNBeMJqPr3KB+Gx6ziaD0sWcT+WsIKjBL5s+Z7GDVi737eny1QxtX+9f+Ue3bBzzdfprl/LV20AGbJoUxgiXTtJ1QcDbKIwBj3VBwKNolCMpOoD6L+P8n3648gprsD7YBHlvz43O5/3/vtA33CyfWmuM/H/02gS4X/3bXeof2uYrTiMU2AUgdE2r/W749/rt/pwOr9yp0+QZsY45rpOr3NIo0mY/xA1F7ifUXL93i+7L80bUyVD/6NNBMLHw2n31Q8wmkT792a/0STG/2V73H1hzrQgwGgTgdCHhxcB2EQiNPMAzR3+z2Yd9rIMje7BYKplDsVTLofi/POtvlyavT9jseYxuOKuGKLNbor9GLdre3oVCmMIg+0ikPb1dn9ojt6hAzZRCNfdpTnPVQvYLALHs8eH6+78Ft+Pcm5277zTZ7CI8X5tm1dumwD9jzYxCH+29eW4PcxcA7S6A+U/m+NXbwBTwwgsI0h4MZxBjG/PyR9ECDj18+L0kpAPYzSJ9e85QKI4AWdHXjxGo4Ibg8irGDYU/pHCZhE44vkhAJk9O5xHmPcf673e7ucKeGATg9AcvxpxaGbmYbMInNmTTwAWfOo5gxiGdSfK6W2ughhNIvyzJ6nAufcU1evZ7opnRgfYRCCcT9dmrlgANjEIl/qtOd2u78ZE4b0ewT4K+fSvetf68xc0isC41P93q69tvf/rNz8ONYzAssfk/t3EaBLv3z9ToNE9GCG7CM44DtO/y/PfFzDj+3T5Nlt4IatYlN/q1/Nh29b+OJuaRuPNFPfQKAbj23FX79+1tVd1RFYRKO326qfGGUT4vh0v9fV0eKv3f+2klL8FSBa+RjF9EM/KIObsUZkXw+nX/sBDVnegvG9nY3xqGrPr957OwW3/Yw7nAmSOgL7EHM15hVrhZG4SPY9BE87lJlf4GDT2VA4mlyWHcl4k4UwOKS6LjuQm0QJO5H7jTmrMH+8/jxu8zB59204sP30bAaTDN9+oENDwKQRgQ24mJzjktEn6OccIMvdjDuofhtLnun0/C4CMgjBCTk9G/zOHJ17f0tkJ8D53dOLl+XSYiauD5zh31jP38yDinP4sKNS/T5sdIUKkWS9Kcz0ftt/e7fwoyGo5ikf/HUEC5F8fBqNrjb49spbPZ6dbcFvQ0TW0iUGwasV/caIAxIBWy1FYzWF075UcvH5vr/84N7vre2GvCSAmllFofRoLwpvYLkccq1RfBGCriEzirS1BOnlMaelbToT6buzDwvLOhyVUd3TxfQgWW9uBFXhJaefDESo7mK8XFXY0bEBd97/SvUTui/vrO+Rp8S1XQweX130YOKb2Y8Bx3XFrT79cr83n4z+NIjrTg6k1P8vnUOXzaXLFs0fUc0j7+tP2dmil7TGGmxjHYsoVCwWcr1rm0Dw1BQYLqCvmsJjaAmN46os53+zajL171+c5/4NkPV1aMAoyjMOy93HP4QxGcRjmzsLZiB6M4jBknQzDzEtlsxnBu/aTrPCY9T8sSYX1KEZgYvBDahBu5B+GKdQi3NU+DJOtSchUWVKXzOEJtQnNzIvqEy6WyN3gpgSvL2/Njhe8xq+99cqS+7WJy+Abt0FPI25Mp6hzkpiIiEj7tN210h3FFHG0lTPD8h5cayPABHVgML1njKXHu3CA3GNe5nTS+R40x2u7Pe6E+ydoH6D1HWL/PBGfa/7Yhnaos7tzQCjyr9tjWBCOto/swaG5hl18b3hvOHDPZxHT2MQifOfleUYO7zXkcTnTHi/PowJ6zFbM151lD69ZlmB9uEE5VsBdmmaDr1/KfEI/lia/4H7I+U+KyftTYDBZXBYUurUkES7BZ3Oh3IdF6TC4H2xGFDqxKCl6w4ScK0oZEXwXngv553hRVzMP84K9ijtvvDvf8V0IPlBdlON4rKDsNsFamtcCsOujeTLAPPRgF32V/UMI5qFGwyVYQXl6grU0Qwdgy7l5gv6ArBww8Fw+nnRlSSYOw2RzMIe7KPsGYLN5dwK8KOMKtE+eiCIWoPjr8IwrPduQ8Tf7jEPSxeW5lwONSb9iRxY8z2FZoSkiBuVhDnFpKg7rgfcxB2Tgp1LX8jGW8iQHuDRVhvVAzpZcHx6QMMOI4HIm16ElaTMYmc2cAvqi5BnWAzZ/cvCLUqgcDsyJqZhHqYE3k9JxHRqHuf2JNPEfHwTw6kzf+89gxE68DzuWmetJ/Wd72e7ieiO1ZSbj5JnKsSMVOVAx47T09Pv+tdDTmUU3AMyvh4/ohbRe8L1YumKE9kJap/lehKzUQadxTLfyLEvyoV+//976zrrZbj0NjcKC9cldzuL1lO/GA1bUBfM6fCo/ImiC1lWxB4tW1tBesGsr34VFq6sHP1VVmmwm950MvXg97W+H+oruMyEr6of1qjnu6z9Xz99Xb/Xlam4KeV7pp+SpWq1Xn7rD5ecXd6OEexDMh/67/6lNyBqLzuQvm9X6ZbPONk86qT58WL+4FvYL+wdrplbrF7XW1dMmyZGZQmZ6tX7RxqwskJVGVslq/ZKsk+wpKzJkliCzdLV+SbmupcgsW61fsnWaPalEIbMMmeWr9UvOecuRWbFavxSctwKZlav1S8mZlcisWq1fKs6swqNrBlttOENFeJCJwEwoiQqFuVBmzJVaJ8WTTolHTIcyw670OlVPRU4sMSPKjLxK1kn1pLMEW2JSlBl8xZKsMC/KjL/K2H5iapShQOXsYGJ2lGFBsWwrTJC2BLGEa0yQtgRVXD81mSuWIZZ0jTnShgitWEvMkTZEaM1aYo60IUInrCXmSBsidMqxqTFH2hChM45NjTnShgjNcqQxR9oQoQvWJ+YoMUTokutngjlKDBGa5SjBHCWGiGTDWpKcZpOaYrMa5igxRCSa9Yk5SgwRScJaYo4SQ0TCzqMEc5QUUgJJMEVJKSSQBBOUVOJkTzBBqWEhYcMjxQSlSpzsKSYo1eIUTjFBaSJOzJSsO5Ygdq1IMUGpJYgNzhQTlFqCStYSE5QWYhinmKG0lKhMMUVpJcZ7iinKNuJqkGGKMiXOjAxTlGlxZmSYoiwRZ0aGKcpScWZkpDqwFFXcwGeYoiyXhjPDDGWFMDMyzE9mWEjZBJ9hgrJKXP8zTFBuWEjZpSDHBOWGhVSzFQ8mKDcspAlriQnKDQspm2ZyTFBuizd2rueYoNywkPKVGangDA0pO9tyzFBeiKVKjjnKLUfswp5jjnJDRMoGUo45KgwRGVtUF5ijwhCRKdYSc1QYIjKWzQJzVBgiMpbNAnNUGCIyls0Cc1TYGptls8AcFYaIjGWzIIV2Ia4bBeaoMERkLO8F5qgwRGRsli0wR6XlqOIipMQclfJaVGKOSkNEzvJeYo5KQ0TO8l5ijkpDRM7yXmKOSkNEzvJeYo5KuxVieS8xR2UhltIl2Q8ZInI2QkrMUVmJpXSJOao24opdYY4qQ0TORl2FOarkorvCHFVy0V1hjirLERufFeaoshyx8VlhjqpcLOQrzFFViIV8hTmqLEdsBqvItrUSS/6K7lwNEwUb9N130NZwUbBh330HbQ0bBRv43XfQ1vBRsKHffQdtDSMFv+PckG3sxnBSsEHdfQdtDSsFG4Ldd9DWigxswHTfQVt5p9R9B20NNwUbXt13wNbqCgUbDGqiORhuSp5jKjtYeaHkOabSgxUYSp5jKj5YiaHkOabygxUZ+BJaUQHCygwlHw9UgrBCQ8nHAxUhrNTA19yKyhCdDsFrMESIUFZu4OtuRaQIZQUHvvJWmspFWqy9FZEjlBUd+OpbEUFCWdmBL1gVkSSUFR54cYtoEqoTJVh5i5BmlQdhcIkqoaz2wGqJisgSyooPJT/fiTChrPwgKGdEmlBWgOALUkXECWUliJLPIwmV+exc43MDESiUlSH44kgRiUJZIaLk8wgRKZSVIgQNj8gUqtMp+PlDlAplFYmKz09ErVBWk6j4/ET0CmVVCX4ZVESxUFaXqPhcRjQLZZWJis9lRLVQVpuo+PyUUoE2lXMOUS5UJ13weYRoF6oTL/g8QtQLZTUKIY8Q/UJZmULII0TCUFao4DfTiogYqlMx2DxCVAxltQo2jxAVQ1mtouKTP9ExlFUrJAGckGb1iopPJBnV1TN5YhI1Q2WeyUYEDZV5JhsRNZSVLoRJQWQNZcWLik9QRNhQVr6o+ARFpA1lBYyKTzpE3FBWwhCKASJvKCtiCBOICBzKyhjCukIkDpV7JltOT0Q8k43IHCr3TDYidKjcM9mI1KHyTo/iMypRO5TVNNgpRNQOVciHV0TuUFbUUBt+eInioayuoTZ88iWih7LSBnv6qIjqoay2oTb8mBHhQ1l5Q21S3pgeZtkJtxGOswhzVuRQm5w3JtQVHXX8nCMiiLJSB3/+RVQQVYqJkqggymodPMtEBlFl4mGZKCGqlIkjUogqfcQRNUSVPuKIIKJKH3FEE1Gljzgii6hOF9nwCZAoI8rqH3yRSKQRVYnEEWlEVTJxRBtRlY84Io8oK4KoDZ+uiUKirA6iFJ96iEiirBTChwRRSVRVeEKCCCWqKj0hQbQSVVWekCByid5s5JDQRC/RVhNRii1WNRFMtBVF2HsNNNFLtNVE2Ns0iFqirSLChoQmYoneZHJIaKKW6I28yGmilmiriLAkayKW6E0pk6yJWqI3lUyyJnKJ7u/QYEnWRC/R3U0aAslEMNFWFFGKXbw0UUx0f7cGu3XQRDLR3Q0b/N0VmmgmurtnQ/GH90Q00d1tG4otWjVRTbSSjss00Uy0Eg80NZFMtJVF+KCgt250924IgUnv3uhu31D8/QaTGzi0J9zoPRw68YQbvY1Dp55wo3dydLKJEG70Zg7dUccuM7rXTuw9Zm+1eRDcu+5es5eX4Y7K76vf+xvQzDBZr+ZeNDM4z99//BhvOTP/M96357O5uw021GM7lRrD9Sovun+NICL4GZ5sOXoab+f7vspL50Hsya09be2DqU7dg6lGR1UGupRpwYG5l5deC2jX4/f/Jv0VpX2/srz/Xmf9h2zTfyhc01L3H6r+g0mz3QdVSp1y7zIDw1KBYam87dAoZJuxXSHxML56DDQEw1BIw98/kae/RxG01qC7ST8UaeVG09Ga9iNhdmICwKEx/wWewfVIl9M/03RsU4KoNjKap9lX87RS0LKELcVe9v+HfAHIPPe3w+MOZlIhd7V/0Rpol4B2no6616eBlilomc613KLLzMAkK7L5tqfh1QTARw58yEMF7v4HcQbSlZuL/Vx1c9RlIe0ma+amZuEma+n+Uik3RxM3RwupQ/0vxMa+JGDGJH37bOiVg0hdN/LcYYnX3D0FD4+4SmBa66+1n1mFu9ZMDADrcjpfFUx6ru9ueJSbuNr5z8UwsS99m/rPwHQopLRnX9zZ2hf/gIkEIkyEHd8CByDB1C2kjDnckQ2HooRroERO39I+zK1B86nKIUNyl7sHTYH4AcwmPbOZy5A6cfHjkmcuDSN6uCAYD5CSS0dt4vxn0uQdfi8ORwgkYbOD87ZEY5MANlMpf/dPW252+ALKCsaohOp+Sg+6u4ENK4mQ+rjfkxmtQGZUUiB0j1ecVFKw+nBlQ58DhnSTDClJdG5fxQtmA4iRXFodTCMckjkgrBSbDS/vAw1BXiilpOJelEcwQW4uxUHvmx66t72A1uBCS5Hr7vdy7vnD7sGKMFIBDVpJfoYfMcGggRmxcGm8dNOwcgvEpp+pZt8heO/eMQauDYRVKTHv3tvXkEQNk0ufCkppjbK/9IHXBOO5cMFXug9V6a6pctckUf65bl/tL3igdxTybqko3YfKOVUb512Kis91O7wTAMx/eOlayuif6zEecCgkMBQ8F4bCCbvIoQuJOeqCdCOFPsQRMG86JPMJDG8p5f6+HYaE1W9PQiolAevgtXvcOvUD18Wew1KiYfh1Isj9YHlzFZhbfkr3oRqqosKFiwjh3iQO0iMYXHFPgYdVVZCPfnT6/lXDMjkUVtJUA7/0g1MCFmuF2ySW7kPlrnHjZp6WeAEvrIf+gfu+r5k0XIMHElYgpitpnwcfujY2hTWduzQpCY4eru7H5/A6YIiKxZp97yQJSg2GQPdZupIG0b24EjQHWd6VWJUUOOa9lLQ8zUHPxdKie9fkdB0AE0qsorofKsKxgmmwcNVgOeRul12daKG15Lp7pAmaomD+JFJ+65oRHioYiomUnrqmfHrRcC/Xp4PK3wfcAzCYbiykQOibc6EId0JGkZccsJcAl5h+kldSxuhdWHt4GWgnJk0F+wZOvDHM4QBIBFA0DVejPvW6hVqlLv1lorvbqyk2r8OLFMF1IEVQGsfj7bVf6TkXMHuKK5YV/ggRBUqMUk6yLVG7FHQ6l/o8vuATAELWxKhxL+sEqRh3G46ZGLzny8mkEjRvQU5IpSzUP98cp/8CjvFGynxDUzzjYNYW153hVZ4fvxFoWI1upF5fTuRSAWgqZbbuudGgERhYt+XNXBHilg1zM1O/tZbmrHvAL0zHkDNReLt+OV3a3a3dnhuiMIJBkIbATg26N9VwZyP2dzqpClilb8QB7BriDFPAlUdUrYamnNZXwJDZeLpNpBGwUqYeYFJsV1C9zaU00L/PFAwtLPPdAruRcqBpfsPt4SGKNC2YDQ5gxlWIWkbtsiZXTMHkJ54VTGrnBKwfohpkW0026wUc540Xse3ftUpSAVRolEyUcUCElhJerZIyb/di1Ma+GBW0hVlbSfm2f+cpaAanvLiTbO17B8FEB2C5W1nFLbBpTWRFOEbi4tQ/HRR0Fuwa3bZDGmDbmIsoyK+45TOlsWnxVh9O58l5CJhTuRRd49te+5Ms7oCkhCuWuIF270cA8Q0CJelT/nAU4PazKnUzT+5k984LnBo1GKGk9zUsJ2rwKYWY0wvQiIH+ZsOJmTT4zgOOmRIusaJgMbbF2RM2TqUwZ8UWSPZcO7YIh3sBcWIilYVcOFzl+DOcD+vVuTnX9tjg+eXDjx//D1SYKLiJpgAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61d25LbOJL9lY3q1+oaAbz7reeyG47d3pkI9+48OBwdskS7uFZJWl2qu8LR/z4EQJCZyUwQpPRUFyXzgDhAZuIAIr8/nA6/nR/effz+8K3Zbx/eKV0+PuzXL/XDu4e/7Jp6f3l4fLiedu2fm936fK7Pf3L/fnq+vOzaz7r/tp8//PHYe1nptHfzeX2u/+e0C/n5YbAB/h4fjuuTaUHflAEhU7oH2Bz258vpurkcTkEQbBcJpHOt0uFmnuv1tj6dgziDTSQG6q7z8+F02VwvPx2b/6zfgkAj0wHvct7+2Jx/PJ6a1/WlnoHedk5Th+9vsFlyf78dTt++7MyoC2FAqyUozaU+rS9Ny3gQBpktwbnU65cwhLdY4v2lfvk8NdoGm1gEMMXf+/sfQfSf3D7RsavJuT60af50J1AxM56DQ7e1OdXtFPr3pt5tx0xQQGy7EHF9PEb0Y291031tfxpHePamnOFCrHq//auLQ0GkwWwxzqW5vP3ydoyAApYL0b4cdm2Iqk/vpwcGNl2I9/V0uB4jwIDdLUg/mz467GMBkflC3GY7BWUtFnrfrT/Xu4jbAXa3IMXh3IDiQn88TYz9YuR4zNvR7I8JnM5mIcL5sj5dYiIUNFyOdZnsNm90A8Y1CuR6A8r1uI3LINBwabZ6Xu+/1tvINEyMmbr4cKk3bZP+rftHs3+uT201uJ1qlF6lJemAuLvnmrEM1eXjuKx9P9Tz+nV6djibOyFu6109fZ+91XJUWBH/bGPkCNT9+/ZaGPjxhfCPKrrxXePm18UQNqYoHgFFVo4IZ7JsDKNsm/P6864eVwQQBBgtwQjUixAlolgM44iVG0SZLNvCGEztBL0HCqew3zZWfml24Q4abJYgnA4T7juDJb5Njgs79xZLvMsZECJMp78wyoxgsnRGB7MrmtX3Sa0xASamNdJ6exZ2TE4f83knPCGbj+/yTnhsHkfzYU4SD2MJGRwF8HnpezxuQO7+0Ka0sWJq/3t75h7csHMt1GjXrvlZG0DGJG0KQ6RrL6mGYIDNIoxeTw2BQKNFKEZSDQF0ny/yffhtzymuwHtvsch/fWw2Ie/d55G+4WR7bs4T4/+HwWSB/83bZlf/0jBLcThOgdECjEt75fv9X+vXenc4vnC7T5BmxnjJfR1eppAGkzj/MWoucD+h5Ia9nzbPzStTJUP/g80ChM+7w+ZbGGAwWew/GP0GkyX+T+v95pnZ04IAg80ChG54BBGAzUKEZhqgucH/0eThIMvQ6BYMplrmUALlcizO31/r06nZhiMWa74EV1wVQ7TJRXEY49oG8BehMIYw2G4B0rZeb3fNPth1wGYRwnlzao5T1QI2W4ATWOPDvDu9xA+jtHn7fXD69BZLvJ/bZMctE6D/wWYJwu9tVbZf7ybuAVrdgPJfzf5bcABTwwVYRpAIYniDJb4DO38QIWLXL4jTSUIhjMFkqf/ABhLFidg7CuIxGhVcGCy8i35BEe4pbLYAR9w/BCCTe4fTCNP+l3pv4/VUAQ9sliC009WIQxMzD5stwJnc+QRg0bueE4hxWDeiHF6nKojBZIF/dicVOA/uogY921XxRO8AmwUIx8O5mSoWgM0ShFP92hyu5/dDoAjej2C/CPnwf/XmEo5f0GgBxqn+/2tbI9TbP7+FcajhAiy7TR5eTQwmy/2HZwo0ugUjZhXBGS/DDK/ywucCJny3H04WXshqKcovdbumakvR8Dgbmy7GmyjuodESjLf9pt62szyoOiKrBSiX9TlMjTdY4Pu6P9Xnw67NHH92UspfIiSL0EVL2iDulUHMya2yIIbXr8MDD1ndgPLhMjnGx6ZLVv3B3Tm47L/P5lyEzBHRliVbc0GhVtiZG42e+6AJ+3KjO7wPGrsrB4PLnE25IJKwJ4cUl1lbcqPRAnbkfuF2asw/b9+P671Mbn3bRszffRsApM23UK8Q0PgpBGBjDpMTHLLbZBIf93WOAWSwiPMPh9LX+vJhEgAZRWHE7J4M/ic2T4K+pb0T4H1q6yTI82E3Ma52ge3cSc/c14OIc/q1oFj/IW12gIiRZoMozbmt/d7eb8IoyGo+SkD/HUAi5N8QBqNrDb4DslbIp9MtuCXo4BraLEGwasV/c6IAxIBW81FYzWFwH5Qcgn6vL387NpvzB2GtCSBGlovQujAWhTeynY84VKmhEYCtFkSSYG0Jwsl9SstQOhHqu6ENM8u7EJZQ3dHkexcstrYDGXhOaRfCESo7GK9nFXZ02IC67p/SWSL/we31HfI0+8hV38D5dR8GXlL7MeC47rheDj+dz83X/d+NIjrRgrE1P8unUOX9aXLHk1vUU0jb+sv6urtIy2MMNzJeiilXLBRwumqZQgvUFBgsoq6YwmJqC4wRqC+mfLO5GXsP5ucp/71kPU4tGAUZLsOy57incHqjZRjmZOHkiO6NlmHIOhmGmZbKJiNCMPeTqHCf/B8XpOJatERgYvBjahCu5++GKdQi3N3eDZOtSchUmVOXTOEJtQmNzLPqE24sgRrlb9xJW/PP22uT3suk9mQbMb8GGQBiDn4TEOa09HguDQjhB1SEffsDLiH/0CYKI0b/GdxP6D9B35L+A7xP6T9B/+fzYdOYIP0f5vBMqJMY0/l48ilOOJ6mDnFGITDZicEI5KZIFHHvlUWb3HwNoYonHgeoyQOPYf9yhQohpqvTEEqgMh1AIqrSIEb7mVTcAxBktQBFPpEIQKYPJIYwQuf4xhEsVJ2GUMRvfw4Qk9/9DPlnVgiD58DqIORTPOs2eJ486jbpf9L7Mt+Tp8MGlOjDYWG8KKTbMMxhucthH55z2Go+CrseHNwH14Ihv4fPZnXXJtJwHxGzBTjSKTSAMXUILeT/uFvv9/X2g/i4kAGHMV2AJ515AzhTR96C/k+HbVtbfj6sT9vgwBoZ3obFbjnwaMF9h1i8f+yuXxvueDCPCcxvww2XrmPLRWiSwoKAptSVEEb45OAAE3dwMIQknRscMKaODUZ4D9au04cGoxAi6tb4I4MTiMwpLoQSOLAV9my3sP7ZXJ4P18s/3BAKQwkXzMeWNbABblr/Cq4xgtoXWF3cR/cKNiWkeYGWLNG76PI9QuuiPXwXLEHjond3FyxW2wLDdI6uFcIRNC24lpulZ9ExQp5sYLaT69Nrs+EPbw0fB/WtOc8eIC6jH0IAWjpTWONQpyQ2ERGR9WW9uRyEb8dTxMFWnu3zW3CujZgU1YDe9JY+lh5VzAFyjyyeOvM33YKmHS7r/YbZlOHaAK0XRtk4Ir7W/BFk2iBnd2OHUOSf1/u4QTjY3rMFu+Ycd/Od4a3DgXvWsBjGRhbxSn3gec+815hHP49bPD+OCuhLjhWEmhMVXYW2RD+QeWmMFXDnhtno+5cin9COucEvuh1y/JPG5O0hMJosLgoKzZoTCOfgs7FQbsOscBjdDjYiCo2YFRSDw4SckZciIvgsPhbyG37U1cS+H2zVsrPzN8c7vgnRXw6YFeN4rKjoNsKaG9cisOu9ecrlNHRvt/guuwdqTkMNhnOwouL0CGtuhI7AlmPzCP0OUTmi47l4PGrKnEgch8nGYA53VvSNwGbj7gh4VsQVaB893VcsQPHH8RFXek8H42/yfR2kifNjLwe6JPyKDYmKwFwr4p5RurTK5BDnhuK4FgQf2Uk6fixrze9jKU5ygHNDZVwL5GjJteEOATOOCC5mcg2aEzajkdnIKaDPCp5xLWDjJwc/K4TKw4E5/S/GUWoQjKS0X/uL49z+QC7hJ9qoydP4H8LnicVGfIg7YjzVkvr3y6mNXotaI13LTMbR+8GW9tTCjlrST3O/yXF7Lgw0ZtaXWabz4T1aIeULvhVzM0ZsK6Q8zbciJlNHnSxnmpVnWZL37fr110voextss576i+IG65O/ndn5lG/GHTLqjHkdP5XvMWii8qrYglmZNbYVbG7lmzAru4amDjm5LuZW+GH8CsUcxuQ3l0nm6Oz4YY4atuxU++2xWGhE9MH9eWsSAS1qRTJGm7seiblXKdqP0edG+hh0OZKN8e8QxWLo4CLYuDFzolckKhu5WORZUSsGnY1YY+hZ0UrATVWVJqvRtz179JfD9rqrz/4IhP8QxqhPj+242da/P7z7/vDajkhzfPHdg35KnqrW8os74vLuoz+O6h+//qn77H9rM4uMhTP50+rh8ePqMdNPafHp0+NHf4H9v/2HtVLtX+pRV09FmSAzhcx0+5d+TFZPaVUiM43Mkvav5DHJn5IiR2YJMkvbv1KmaSmyytq/sse0eEpyjcwyZJa3f+WMsxxZFe1fBeesQGZl+1f5mLZ9XmFvJTJrGflYcd4q3Lmmr9WKM1SEBpkHTIQSmVCYCmW6XKnHpHgqV/heFGZDmW5vs1WqntIyxZaYEWV6XiWsJSZFmd5XHMcK86JM/6uMbSamRhkKVM6RozA7yrCgCtYSE6QtQSVHkMYEaUtQxbVTk6liGVpx6BpTpA0PWrGWmCJteNCatcQUacODTlhLTJE2RLRJK6laiogl5kgbInTGkKkxRdrwoFmKNKZIGx50wbnEDCWGhrYMZFqZYIYSQ4NmGUowQ4mhIVmxliSe2YCm2IiGGUoMDYlmfWKGEkNDkrCWmKHE0JBwkyjBBCWFFD0STFBSStEjwfwklTjTE0xQalhIuMGRYn5SJc70FPOTanH+ppifNBFnZUpSjuWHyxMppie19HAjM8XspJadkjPE7KSFOIRTTE9aSjymmJ60Esd6iunJVmIayDA/mRJnRYb5ybQ4KzLMT5aIsyLD/GSpOCsyUhZYgiqm3zNMUJZLvZlhgrJCmhUZ5iczLKRsPs8wQVklZv4ME5QbFlLFWeaYoNywkGqu1MH85IaENGFdYn5yQ0LKRZgc05Pbko2b5TlmJzccpGw9Rso2w0HKzbMcs5MXYnmSY3pySw9bvuWYntxwkHJjKMfsFIaCjCujC0xOYSjIFGeIySkMAxnHYoG5KQwDWcIZYm4Kw0CWssUtJqewJTVbUxeYncJwkOWsJSmsCzFTFJiewnCQcYwXmJ3CcJCxVVmB6SktPRUHXmJ+Sjn7lJig0tCQc5SXmKDS0JBzlJeYoNKwkGvufkpMUGlYyDnOS8xPaVc93MQtMT2lpYctyUqy9DEk5NwULzE9pY1tLD0lpqdaiem5wvRUhoOcCxsVZqeSq+sK01PJ1XWF+aksP9zArDA9laWHS/kVpqeytTVbr1eYn8rmHrZerzA/leWHi1kVWZza4oAt7Cu6PjUsFMIClaxQV4aIgk1U7jNoa6gouCDnPoKmhouCG/LuI2hq2CjYQOc+g7aGkIINde4zaGsoKdhg5z6DtlZIYJUE9xm0lZdD7jNoa5gpuKHlPgKmVjoouIGgRqqC4aXkYpmiuoKVD0oumimqLFj9oGTZpdKCFRBKll2qLVgFgS+TFVUXrIhQsvIC1ResilByYU1RgcHKCHxVrajE4DQGXl4hIoOyUgJfWSsiMygrJvC1tdJUCrJ1OFtdKyI1KCso8PW1ImKDspICX5IqIjcoKyrwwhXRG5QTHHjpipBmdQWhd4nmoKyywE90Ijooqy2UXJZRRHZQVlwQRDEiPCgrL/B1pyLSg7ICQ8nlGpVQAc9OMzYkEPFBWYmBr4MUkR+UFRlKNnwQ/UFZmUEQ54gEoZwGwU8eokIoKzZUbFgiOoSyakPFhiUiRCirN/B5TxEtQlnFoWJDGBEjlJUcKjaEETVCWc2hYsNSSjXXVI41RJFQTpLg4wcRJZRTJfj4QXQJZdUHIX4QZUJZAUKIH0ScUFaC4JfJisgTyukTbPwg+oSyKgQfP4hAoawMUbFBnygUyuoQkqZNSLNKRMXGj4wq5Zk8I4lOobLANCNShcoC04yoFcpqEsKEIHqFsqpExdc1RLFQVpeo2MBEJAtllYmKDTZEtFBWmhDyP5EtlFUnhNlDlAtlBQohlxDxQuWBmZbTHY7ATCMShsoDM42IGCoPzDQiYyinY7BKjyJKhirkmUa0DFXIM42oGcqKFnzqI3qGsrJFu6zgBgORNFQR2JMiooay0oWQfomsoax40S5X2DbQnSlDDK+rKCJtKKdt8FUIUTeUkzf45QbRN5QTONi1tiIKh7I6hhByiMahrJQhhBwic6jS8cYmS6J0qIDUoYjWoaykIW3oEd6sqiFs6RHFQ5WBEEk0D2WlDV5OUET2UFbc4AUFRYQPZeUNXgBQRPpQVuHgJQBF1A9lNY52YcxxQfQP5QQQPvwTBURZoaNdRLN+CW9W6xBEA6KDqMrNNzYTEyVEWb1DEBiIFqKs5NEuzlm/dDfYafFszU0EEb1yO/ZcbtNEENFW9GhX56wt2RO2qgefXjVRRLRTRNi4o4kkop0kwsYdTSQR7SQRNu5oIoloJ4kI7SW7w1b2EHZ9iSSireyhFJcDNJFEtNU9+IJAE01EW+GDLwg0EUW0O2vBFgSaqCJayVvFmsgiWsmbxZroIlrJ28WaCCNayRvGmggj2p27UFx+00QZ0Urc9tJEGdFK3JjURBjRnTAi3BqhzZ2/UFw40/QAhlNG2N4dncCwUVKlbBvoIQztDsqwuVDTcxjaFZM5b0yIc9pIm7VYY8KcdsyxkYeex9DiaSZNT2Roccdf0yMZVgLhSSbqiHbqiEAykUd0IhNH1BGdhIgj+ohOQsQRhUQnIeKIRKKTEHFEJNFOJFFsGiAiibZCCFupaqKRaPmohiYaiU5k4ohGotMQcUQk0e7EhmaDNVFJtDuzodnAQ2QSnYrHBDWRSXSaBgYE0Ul0mgUGBBFKdJoHBgRRSnRaBAYEkUq0O8WhuXpZE6lEp+JJQk2UEm3lEH5AEKVEZ+JpQk2UEp3pwIAgWonOAhmOaCXaHejgTemRtSxAMhFLtBNLBJKJWqKdWiKQTOQSnZUBkoleot0BD81mLqKX6NxpyVxxrYlgonM359jDdkQx0bmbc1wRrIlioq0qovgTd0Qx0VYV4UcaEUx0Lsr/mugl2ukl7IAgcol2Rz6EQUn0Ep276cYmTqKX6LwKjDQimGgnmAgjjUgmulCBkUZEE13owEgjsol2solm8wuRTbSTTRI2YhPZRFtphGeZqCa6EE9SaSKa6CJEHVFNtFVG+CFBRBNdhJgjqokuQ8wR2USXIeaIbqLLEHNEONFOOEnYnNgJJ/bQ/2ttnnn63h3+//ix/zLe94dfu28EgC9CfX8wo/rd9z/+GL4DYP4y3tfHo/m6AbpwuK5dV7SGjw/tBLI/zT6W+6VIJYf9mx4GlyloimuJcaW8q0xy1b/M4Wv3MgfQypUCzWyHlODiejms7Uu/Du6lX4OHKgMO2rTFOzDfa6IdBK7rbqH7mXTdlHb3mOXd5zrrfsn6/ut+MYsh90tbMLtfEv9L1rk1cdH9It7nZ/tmcdzpFej0Kngd6pdsNVznWsldd1rvN881oiQDHVMo4cLuObDdd1PA1Ro01w+NtPL96wdN2g1II9l3/Sc1cbNrzJ8AAtyYeJF7lexwTVkAthNplNjLvpmXxIIrS3hlIl7p/obEAchcIrz7GxMAZm4hN/XlpSHXJeC6QEP9C0/AlSm40lNTFFMu1uh+MzARCz9RCilgASeH/oHPwFkOnPnpV0jDH31vEoxFEDn9DO5muJ/ZPiBqj5H14czPWlX4me2nuL9a+zBgiqNuZktB0D/5ZGhdAuZZ0k2DrG+nb0bqG5bnvj1+ymQix+6VhZgelcA42XVDNzEL3w0TLsfTXcEo6m/CB0fl5732/vt+UmJguZ4vh5cxUAZmkzyo3jbtmGpeUD+nYFzmUrobXmUDIMHML/ytlFLI6b/aB7sc9I7J+8Er7bv4GjQvqxxyJrfdPVcZDC3AddJxnfl5rRM/tHw09rlcK2n0otfwgB4Cwb70rCceKPNBoJTI7h+aBssW2GepFP66K1FvJYDoVKTJvT672eA7KSs4jqVu8M+Tg81dweZKN1rvt1sy/RWIuUpKD7V9M9GoJoQlj69VuoBR+sCR9BHN/1JKnVnbV8OBGQOGT+4jklh7mKvxsM1BnwRBcShJYFeKham97uyfBgCZqODl0mSzl49nmtnkHPpUnKr1uY0uhMgcDFj5wu7FTKSjAGjpp00p3nnno41T31DP5YCvUhy77iE4/gXZ/s2fsANBtNG5xFv/nX2YBGCmVX0B7LNj6n/x6U37hYgWi4wv5tU96CbBfCml+eJfTdWQLAXjaBfsSp+TxB4Db+qDA2UFJ5/Et/06PewhMGW1j8Dap30jUXY95LN8v7AQE04L8WK/Nw9hIIXaJ1sfkbUvJnTW97+vcsQY3cJ0b7JA8RL2qJZCQ3ttP97wUEvhUAvcIRqu2EUBXQR4CI14yEou9oBZtZKJCy4spWqkuw5DwnVIN1FSH2LFYW09mf+0+Zc6hPJAN2ZKiY/+iRcgaYJKoRsKvvbUfv1mtPlu3PiR1FejYi323JxpnEgB6yJjJC7DoO6Xk11rqr7i6MvXfk5LYQU8cwNOGzgctQ9Sif/Fr1a1r2h07mOcuCTpn6eOgwdgv2t9NumBDD0w8yppyMKnuQ+XwhLacy12VO+By7Vo1Glp2Np31pHxiuqlroOrfgJIg8m//Q74gWWiHxC+shUnwK6dAHR9kINuqaTca3KukTtoUgL9UEl5xD1lBPYeDF1eU9K+UDe7St1w83V54UeiWE25x6iiiQ3GdCIx5C4jFFVwlCYSJe5SPihpWA90k6fyZWglhfv+UbCgKaB7fe9I3HaXs6Uhao98R+y9gAjpuap8nBEnYOfLXgjvBy2XxTvxry2kNSpcwlfiUDi80rV/DvtRun3aVpyjuxv3y2Bf0ik/RlUlBfT99cXV7P5VZaA7kEYt9WXroKtAOBewT8TlYv8mRZo9V3AVJs5+KzqTSwsUy313iEHAukAOUnDzYu3RvTbR3vhoBbmC68BKmuPDGxFB4+E4XPklYyUlg+Opfm0O1zNISbgvII8riQT4fj86smE5KY5Q6ICOVnPKD7iQphZ0cbSvNaQtQfWUFKqgG7qtsIIly0ok9nQw2QRFbNAJqTQUu3cX4lYXcBKspInYX4pDLOy3zEdZkcT+pYaf30gb4Exa+YpJbMzpQG4eNCOVJpF7Vxm4CIw7v8jJfBHgqwuV9uqjT6xK6l3/pimYrGH819KAOD8fTpfN9bI+NmT/AHSLiMrNbrQ2kSYmExALGBRWvqZYBbFpvijgdFz5Un8l0uJ9cEp+AcfXyjOwkqLVaKGXgAmZBq/Cwxpu24grzO51kKDX4QLap7aVr8NWAR4uV+wI1nhSNGIW1oA9L59qKR76rMgV6LA8FuXFzsFv7hWVx/4VldARrNdXoZagUZ+AIJjJ46a9aqRmFZC5Vajr3i71S5sgqZZXQC1X3Fd0DoiyWsKkLu5RnN/aFeS2TYYv6FqYU5UUPy/rM77dEuZOJYVL83YaFFUAWO6LDy1NcnM12VmAfSRWH907cUBjgezRgfZrk0SaHNYLN0ZhohSXKGa5Zq54rXeH42iPFUzXXBpm1/2pPh92bVXcbZNzm64lTKFifvCvAAUDHYwYLxj0e4hekFFe31P9EQBxgHTvccUBGR4C8bJqn9ZU79xTIc4ar4WhPgR30Ffz4irLe8DDqYTJXww3w7U4VMOLU2kGsEIipH/qOnZhiBZ3U/fM7BuUMNsqdgZ8enw4Nsfa7i6++/jpjz/+BQsdJTVmzAAA"; \ No newline at end of file diff --git a/docs/classes/Client.html b/docs/classes/Client.html index 086c607..6ba4e27 100644 --- a/docs/classes/Client.html +++ b/docs/classes/Client.html @@ -1,4 +1,4 @@ -Client | shortcut-api

Class Client

Constructors

constructor +Client | shortcut-api

Class Client

Constructors

constructor

Properties

iterations members shortcutApiKey @@ -7,4 +7,4 @@ workflows baseUrl

Accessors

headers -

Constructors

constructor

Properties

iterations

iterations: IterationsService

members

members: MembersService

Private Readonly shortcutApiKey

shortcutApiKey: undefined | string

stories

stories: StoriesService

teams

teams: TeamService

workflows

workflows: WorkflowsService

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

Accessors

headers

  • get headers(): ShortcutHeaders

  • Returns ShortcutHeaders

Settings

Member Visibility

Theme

On This Page

constructoriterationsmembersshortcutApiKeystoriesteamsworkflowsbaseUrlheaders

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

iterations

iterations: IterationsService

members

members: MembersService

Private Readonly shortcutApiKey

shortcutApiKey: undefined | string

stories

stories: StoriesService

teams

teams: TeamService

workflows

workflows: WorkflowsService

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

Accessors

headers

  • get headers(): ShortcutHeaders

  • Returns ShortcutHeaders

Settings

Member Visibility

Theme

On This Page

constructoriterationsmembersshortcutApiKeystoriesteamsworkflowsbaseUrlheaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Iteration.html b/docs/classes/Iteration.html index 4052dab..fd5c8d3 100644 --- a/docs/classes/Iteration.html +++ b/docs/classes/Iteration.html @@ -1,4 +1,4 @@ -Iteration | shortcut-api

Class Iteration

Inherit Doc

Hierarchy

  • default
    • Iteration

Constructors

constructor +Iteration | shortcut-api

Class Iteration

Inherit Doc

Hierarchy

  • default
    • Iteration

Constructors

constructor

Properties

appUrl changedFields createFields @@ -23,28 +23,28 @@ delete save update -

Constructors

constructor

Properties

appUrl

appUrl: string

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

-

createFields

createFields: string[] = ...

createdAt

createdAt: Date

endDate

endDate: string

entityType

entityType: string

followerIds

followerIds: string[]

groupIds

groupIds: string[]

groupMentionIds

groupMentionIds: string[]

id

id: number

labelIds

labelIds: number[]

labels

labels: Label[]

memberMentionIds

memberMentionIds: string[]

mentionIds

mentionIds: string[]

name

name: string

startDate

startDate: Date

stats

stats: IterationStats

status

status: "unstarted" | "started" | "done"

updatedAt

updatedAt: Date

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/iterations'

Methods

create

  • create(): Promise<Iteration>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    +

Constructors

constructor

Properties

appUrl

appUrl: string

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

+

createFields

createFields: string[] = ...

createdAt

createdAt: Date

endDate

endDate: string

entityType

entityType: string

followerIds

followerIds: string[]

groupIds

groupIds: string[]

groupMentionIds

groupMentionIds: string[]

id

id: number

labelIds

labelIds: number[]

labels

labels: Label[]

memberMentionIds

memberMentionIds: string[]

mentionIds

mentionIds: string[]

name

name: string

startDate

startDate: Date

stats

stats: IterationStats

status

status: "unstarted" | "started" | "done"

updatedAt

updatedAt: Date

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/iterations'

Methods

create

  • create(): Promise<Iteration>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    Returns Promise<Iteration>

    • A Promise that resolves with the newly created instance.

    Throws

    • Throws an error if the HTTP request fails.
    -

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    +

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    Returns Promise<void>

    • A Promise that resolves when the resource has been deleted.

    Throws

    • Throws an error if the HTTP request fails.
    -

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. +

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. Otherwise, it will be created using the fields createFields.

    -

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    +

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    Returns Promise<void>

    • A Promise that resolves when the resource has been updated.

    Throws

    • Throws an error if the HTTP request fails.
    -

Settings

Member Visibility

Theme

On This Page

constructorappUrlchangedFieldscreateFieldscreatedAtendDateentityTypefollowerIdsgroupIdsgroupMentionIdsidlabelIdslabelsmemberMentionIdsmentionIdsnamestartDatestatsstatusupdatedAtbaseUrlcreatedeletesaveupdate

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorappUrlchangedFieldscreateFieldscreatedAtendDateentityTypefollowerIdsgroupIdsgroupMentionIdsidlabelIdslabelsmemberMentionIdsmentionIdsnamestartDatestatsstatusupdatedAtbaseUrlcreatedeletesaveupdate

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/IterationsService.html b/docs/classes/IterationsService.html index da0650d..3b9acc9 100644 --- a/docs/classes/IterationsService.html +++ b/docs/classes/IterationsService.html @@ -1,4 +1,4 @@ -IterationsService | shortcut-api

Class IterationsService

Hierarchy

Constructors

constructor +IterationsService | shortcut-api

Class IterationsService

Hierarchy

Constructors

constructor

Properties

baseUrl headers instances @@ -8,4 +8,4 @@ getMany list

Constructors

constructor

  • new IterationsService(init): IterationsService

  • Service classes are not intended to be instantiated directly. Instead, use the Client class to create instances of services.

    -

    Parameters

    • init: {
          headers: Record<string, string>;
      }
      • headers: Record<string, string>

    Returns IterationsService

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/iterations'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Iteration> = {}

Static iterations

iterations: Record<number, Iteration> = {}

Methods

Protected factory

get

getMany

list

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesiterationsfactorygetgetManylist

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • init: {
        headers: Record<string, string>;
    }
    • headers: Record<string, string>

Returns IterationsService

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/iterations'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Iteration> = {}

Static iterations

iterations: Record<number, Iteration> = {}

Methods

Protected factory

get

getMany

list

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesiterationsfactorygetgetManylist

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Member.html b/docs/classes/Member.html index 0727578..3289b74 100644 --- a/docs/classes/Member.html +++ b/docs/classes/Member.html @@ -1,4 +1,4 @@ -Member | shortcut-api

Class Member

Inherit Doc

Hierarchy

  • default
    • Member

Constructors

constructor +Member | shortcut-api

Class Member

Inherit Doc

Hierarchy

  • default
    • Member

Constructors

constructor

Properties

baseUrl changedFields createFields @@ -16,30 +16,30 @@ delete save update -

Constructors

constructor

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/members'

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

-

createFields

createFields: string[] = []

Fields that are used when creating a new resource

-

createdAt

createdAt: string

disabled

disabled: boolean

entityType

entityType: string

groupIds

groupIds: string[]

id

id: string

profile

profile: object

role

role: string

state

state: "disabled" | "full" | "imported" | "partial"

updatedAt

updatedAt: string

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

The base URL for the API endpoint related to the resource

-

Methods

create

  • create(): Promise<Member>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    +

Constructors

constructor

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/members'

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

+

createFields

createFields: string[] = []

Fields that are used when creating a new resource

+

createdAt

createdAt: string

disabled

disabled: boolean

entityType

entityType: string

groupIds

groupIds: string[]

id

id: string

profile

profile: object

role

role: string

state

state: "disabled" | "full" | "imported" | "partial"

updatedAt

updatedAt: string

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

The base URL for the API endpoint related to the resource

+

Methods

create

  • create(): Promise<Member>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    Returns Promise<Member>

    • A Promise that resolves with the newly created instance.

    Throws

    • Throws an error if the HTTP request fails.
    -

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    +

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    Returns Promise<void>

    • A Promise that resolves when the resource has been deleted.

    Throws

    • Throws an error if the HTTP request fails.
    -

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. +

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. Otherwise, it will be created using the fields createFields.

    -

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    +

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    Returns Promise<void>

    • A Promise that resolves when the resource has been updated.

    Throws

    • Throws an error if the HTTP request fails.
    -

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlchangedFieldscreateFieldscreatedAtdisabledentityTypegroupIdsidprofilerolestateupdatedAtbaseUrlcreatedeletesaveupdate

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlchangedFieldscreateFieldscreatedAtdisabledentityTypegroupIdsidprofilerolestateupdatedAtbaseUrlcreatedeletesaveupdate

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/MembersService.html b/docs/classes/MembersService.html index 66d74da..842dffc 100644 --- a/docs/classes/MembersService.html +++ b/docs/classes/MembersService.html @@ -1,4 +1,4 @@ -MembersService | shortcut-api

Class MembersService

Hierarchy

Constructors

constructor +MembersService | shortcut-api

Class MembersService

Hierarchy

Constructors

constructor

Properties

baseUrl headers instances @@ -9,4 +9,4 @@ getMany list

Constructors

constructor

  • new MembersService(init): MembersService

  • Service classes are not intended to be instantiated directly. Instead, use the Client class to create instances of services.

    -

    Parameters

    • init: {
          headers: Record<string, string>;
      }
      • headers: Record<string, string>

    Returns MembersService

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/members'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Member> = {}

Static members

members: Record<number, Member> = {}

Methods

create

Protected factory

get

getMany

  • getMany(ids): Promise<Member[]>

  • Parameters

    • ids: string[] | number[]

    Returns Promise<Member[]>

list

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesmemberscreatefactorygetgetManylist

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • init: {
        headers: Record<string, string>;
    }
    • headers: Record<string, string>

Returns MembersService

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/members'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Member> = {}

Static members

members: Record<number, Member> = {}

Methods

create

Protected factory

get

getMany

  • getMany(ids): Promise<Member[]>

  • Parameters

    • ids: string[] | number[]

    Returns Promise<Member[]>

list

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesmemberscreatefactorygetgetManylist

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/StoriesService.html b/docs/classes/StoriesService.html index 84d93b2..7373c8a 100644 --- a/docs/classes/StoriesService.html +++ b/docs/classes/StoriesService.html @@ -1,4 +1,4 @@ -StoriesService | shortcut-api

Class StoriesService

Inherit Doc

Hierarchy

  • default<Story>
    • StoriesService

Constructors

constructor +StoriesService | shortcut-api

Class StoriesService

Inherit Doc

Hierarchy

  • default<Story>
    • StoriesService

Constructors

constructor

Properties

baseUrl headers instances @@ -7,8 +7,8 @@ getMany list search -

Constructors

constructor

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/stories'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Story> = {}

Methods

Protected factory

get

getMany

  • getMany(ids): Promise<Story[]>

  • Parameters

    • ids: string[] | number[]

    Returns Promise<Story[]>

list

search

Constructors

constructor

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/stories'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Story> = {}

Methods

Protected factory

get

getMany

  • getMany(ids): Promise<Story[]>

  • Parameters

    • ids: string[] | number[]

    Returns Promise<Story[]>

list

search

  • search(query): Promise<Story[]>

  • Search for stories using the Shortcut Syntax

    Parameters

    • query: string

    Returns Promise<Story[]>

    Example

    const client = new Client()
    const stories = client.stories.search('type:bug')

    Throws

    Error if the HTTP status code is 400 or greater

    -

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesfactorygetgetManylistsearch

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesfactorygetgetManylistsearch

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Story.html b/docs/classes/Story.html index 14228c1..4f93d10 100644 --- a/docs/classes/Story.html +++ b/docs/classes/Story.html @@ -2,7 +2,7 @@ -

Hierarchy

Constructors

constructor +

Hierarchy

  • default
    • Story

Constructors

constructor

Properties

appUrl archived blocked @@ -70,47 +70,47 @@ save timeInDevelopment update -

Constructors

constructor

Properties

appUrl

appUrl: string

archived

archived: boolean

blocked

blocked: boolean

blocker

blocker: boolean

branches

branches: Branch[]

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

-

comments

comments: StoryComment[]

commits

commits: Commit[]

completed

completed: boolean

completedAt

completedAt: null | Date

completedAtOverride

completedAtOverride: null | Date

createFields

createFields: string[] = []

Fields that are used when creating a new resource

-

createdAt

createdAt: Date

customFields

customFields: StoryCustomField[]

deadline

deadline: null | Date

description

description: string

entityType

entityType: string

epicId

epicId: null | number

estimate

estimate: null | number

externalId

externalId: null | string

externalLinks

externalLinks: string[]

files

files: UploadedFile[]

followerIds

followerIds: string[]

groupId

groupId: null | string

groupMentionIds

groupMentionIds: string[]

id

id: number

iterationId

iterationId: null | number

labelIds

labelIds: number[]

labels

labels: LabelSlim[]

leadTime

leadTime: number

linkedFiles

linkedFiles: LinkedFile[]

memberMentionIds

memberMentionIds: string[]

mentionIds

mentionIds: string[]

movedAt

movedAt: null | Date

name

name: string

ownerIds

ownerIds: string[]

position

position: number

previousIterationIds

previousIterationIds: number[]

projectId

projectId: null | number

requestedById

requestedById: string

started

started: boolean

startedAt

startedAt: null | Date

startedAtOverride

startedAtOverride: null | Date

stats

stats: StoryStats

storyLinks

storyLinks: TypedStoryLink[]

storyTemplateId

storyTemplateId: null | string

storyType

storyType: string

syncedItem

syncedItem: SyncedItem

tasks

tasks: Task[]

unresolvedBlockerComments

unresolvedBlockerComments: number[]

updatedAt

updatedAt: null | Date

workflowId

workflowId: number

workflowStateId

workflowStateId: number

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

The base URL for the API endpoint related to the resource

-

Accessors

epic

  • get epic(): Promise<default>

  • Get the epic of the story

    -

    Returns Promise<default>

iteration

owners

team

  • get team(): Promise<Team>

  • Get the team assigned to the story, labelled as "Group" in the Shortcut API

    -

    Returns Promise<Team>

workflow

  • get workflow(): Promise<WorkflowStateInterface>

  • Returns Promise<WorkflowStateInterface>

Methods

comment

  • comment(comment): Promise<void | StoryComment>

  • Parameters

    • comment: string

    Returns Promise<void | StoryComment>

create

  • create(): Promise<Story>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    +

Constructors

constructor

Properties

appUrl

appUrl: string

archived

archived: boolean

blocked

blocked: boolean

blocker

blocker: boolean

branches

branches: Branch[]

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

+

comments

comments: StoryComment[]

commits

commits: Commit[]

completed

completed: boolean

completedAt

completedAt: null | Date

completedAtOverride

completedAtOverride: null | Date

createFields

createFields: string[] = []

Fields that are used when creating a new resource

+

createdAt

createdAt: Date

customFields

customFields: StoryCustomField[]

deadline

deadline: null | Date

description

description: string

entityType

entityType: string

epicId

epicId: null | number

estimate

estimate: null | number

externalId

externalId: null | string

externalLinks

externalLinks: string[]

files

files: UploadedFile[]

followerIds

followerIds: string[]

groupId

groupId: null | string

groupMentionIds

groupMentionIds: string[]

id

id: number

iterationId

iterationId: null | number

labelIds

labelIds: number[]

labels

labels: LabelSlim[]

leadTime

leadTime: number

linkedFiles

linkedFiles: LinkedFile[]

memberMentionIds

memberMentionIds: string[]

mentionIds

mentionIds: string[]

movedAt

movedAt: null | Date

name

name: string

ownerIds

ownerIds: string[]

position

position: number

previousIterationIds

previousIterationIds: number[]

projectId

projectId: null | number

requestedById

requestedById: string

started

started: boolean

startedAt

startedAt: null | Date

startedAtOverride

startedAtOverride: null | Date

stats

stats: StoryStats

storyLinks

storyLinks: TypedStoryLink[]

storyTemplateId

storyTemplateId: null | string

storyType

storyType: string

syncedItem

syncedItem: SyncedItem

tasks

tasks: Task[]

unresolvedBlockerComments

unresolvedBlockerComments: number[]

updatedAt

updatedAt: null | Date

workflowId

workflowId: number

workflowStateId

workflowStateId: number

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

The base URL for the API endpoint related to the resource

+

Accessors

epic

iteration

owners

team

  • get team(): Promise<Team>

  • Get the team assigned to the story, labelled as "Group" in the Shortcut API

    +

    Returns Promise<Team>

workflow

  • get workflow(): Promise<WorkflowStateInterface>

  • Returns Promise<WorkflowStateInterface>

Methods

comment

  • comment(comment): Promise<void | StoryComment>

  • Parameters

    • comment: string

    Returns Promise<void | StoryComment>

create

  • create(): Promise<Story>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    Returns Promise<Story>

    • A Promise that resolves with the newly created instance.

    Throws

    • Throws an error if the HTTP request fails.
    -

cycleTime

  • cycleTime(): Promise<number>

  • Calculates the cycle time of a story in houts.

    +

cycleTime

  • cycleTime(): Promise<number>

  • Calculates the cycle time of a story in hours.

    Returns Promise<number>

    • The cycle time in hours.

    Throws

    • If the story is not completed or has not been started.
    -

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    +

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    Returns Promise<void>

    • A Promise that resolves when the resource has been deleted.

    Throws

    • Throws an error if the HTTP request fails.
    -

history

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. +

history

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. Otherwise, it will be created using the fields createFields.

    -

    Returns Promise<void>

timeInDevelopment

  • timeInDevelopment(): Promise<number>

  • Calculates the time a story has been in development in hours.

    +

    Returns Promise<void>

timeInDevelopment

  • timeInDevelopment(): Promise<number>

  • Calculates the time a story has been in development in hours.

    Returns Promise<number>

    • The time in development in hours.

    Throws

    • If the story is already finished or not started.
    -

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    +

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    Returns Promise<void>

    • A Promise that resolves when the resource has been updated.

    Throws

    • Throws an error if the HTTP request fails.
    -

Settings

Member Visibility

Theme

On This Page

constructorappUrlarchivedblockedblockerbrancheschangedFieldscommentscommitscompletedcompletedAtcompletedAtOverridecreateFieldscreatedAtcustomFieldsdeadlinedescriptionentityTypeepicIdestimateexternalIdexternalLinksfilesfollowerIdsgroupIdgroupMentionIdsiditerationIdlabelIdslabelsleadTimelinkedFilesmemberMentionIdsmentionIdsmovedAtnameownerIdspositionpreviousIterationIdsprojectIdrequestedByIdstartedstartedAtstartedAtOverridestatsstoryLinksstoryTemplateIdstoryTypesyncedItemtasksunresolvedBlockerCommentsupdatedAtworkflowIdworkflowStateIdbaseUrlepiciterationownersteamworkflowcommentcreatecycleTimedeletehistorysavetimeInDevelopmentupdate

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorappUrlarchivedblockedblockerbrancheschangedFieldscommentscommitscompletedcompletedAtcompletedAtOverridecreateFieldscreatedAtcustomFieldsdeadlinedescriptionentityTypeepicIdestimateexternalIdexternalLinksfilesfollowerIdsgroupIdgroupMentionIdsiditerationIdlabelIdslabelsleadTimelinkedFilesmemberMentionIdsmentionIdsmovedAtnameownerIdspositionpreviousIterationIdsprojectIdrequestedByIdstartedstartedAtstartedAtOverridestatsstoryLinksstoryTemplateIdstoryTypesyncedItemtasksunresolvedBlockerCommentsupdatedAtworkflowIdworkflowStateIdbaseUrlepiciterationownersteamworkflowcommentcreatecycleTimedeletehistorysavetimeInDevelopmentupdate

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Team.html b/docs/classes/Team.html index 192ba8f..14039f5 100644 --- a/docs/classes/Team.html +++ b/docs/classes/Team.html @@ -1,4 +1,4 @@ -Team | shortcut-api

Class Team

Inherit Doc

Hierarchy

  • default
    • Team

Constructors

constructor +Team | shortcut-api

Class Team

Inherit Doc

Hierarchy

  • default
    • Team

Constructors

constructor

Properties

appUrl archived changedFields @@ -22,28 +22,28 @@ getStories save update -

Constructors

constructor

  • new Team(init?): Team

  • Parameters

    • Optional init: object

    Returns Team

Properties

appUrl

appUrl: string

archived

archived: boolean

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

-

color

color: string

colorKey

colorKey: string

createFields

createFields: string[] = ...

description

description: string

displayIcon

displayIcon: string

entityType

entityType: string

id

id: string

memberIds

memberIds: number[]

mentionName

mentionName: string

name

name: string

numEpicsStarted

numEpicsStarted: number

numStoriesStarted

numStoriesStarted: number

workflowIds

workflowIds: number[]

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/groups'

Accessors

stories

Methods

create

  • create(): Promise<Team>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    +

Constructors

constructor

  • new Team(init?): Team

  • Parameters

    • Optional init: object

    Returns Team

Properties

appUrl

appUrl: string

archived

archived: boolean

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

+

color

color: string

colorKey

colorKey: string

createFields

createFields: string[] = ...

description

description: string

displayIcon

displayIcon: string

entityType

entityType: string

id

id: string

memberIds

memberIds: number[]

mentionName

mentionName: string

name

name: string

numEpicsStarted

numEpicsStarted: number

numStoriesStarted

numStoriesStarted: number

workflowIds

workflowIds: number[]

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/groups'

Accessors

stories

Methods

create

  • create(): Promise<Team>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    Returns Promise<Team>

    • A Promise that resolves with the newly created instance.

    Throws

    • Throws an error if the HTTP request fails.
    -

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    +

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    Returns Promise<void>

    • A Promise that resolves when the resource has been deleted.

    Throws

    • Throws an error if the HTTP request fails.
    -

getStories

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. +

getStories

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. Otherwise, it will be created using the fields createFields.

    -

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    +

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    Returns Promise<void>

    • A Promise that resolves when the resource has been updated.

    Throws

    • Throws an error if the HTTP request fails.
    -

Settings

Member Visibility

Theme

On This Page

constructorappUrlarchivedchangedFieldscolorcolorKeycreateFieldsdescriptiondisplayIconentityTypeidmemberIdsmentionNamenamenumEpicsStartednumStoriesStartedworkflowIdsbaseUrlstoriescreatedeletegetStoriessaveupdate

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorappUrlarchivedchangedFieldscolorcolorKeycreateFieldsdescriptiondisplayIconentityTypeidmemberIdsmentionNamenamenumEpicsStartednumStoriesStartedworkflowIdsbaseUrlstoriescreatedeletegetStoriessaveupdate

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/TeamService.html b/docs/classes/TeamService.html index 4006cfc..381c2ee 100644 --- a/docs/classes/TeamService.html +++ b/docs/classes/TeamService.html @@ -1,4 +1,4 @@ -TeamService | shortcut-api

Class TeamService

Hierarchy

  • default<Team>
    • TeamService

Constructors

constructor +TeamService | shortcut-api

Class TeamService

Hierarchy

  • default<Team>
    • TeamService

Constructors

constructor

Properties

baseUrl headers instances @@ -10,4 +10,4 @@ getMany list

Constructors

constructor

  • new TeamService(init): TeamService

  • Service classes are not intended to be instantiated directly. Instead, use the Client class to create instances of services.

    -

    Parameters

    • init: {
          headers: Record<string, string>;
      }
      • headers: Record<string, string>

    Returns TeamService

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/groups'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Team> = {}

Static teams

teams: Record<number, Team> = {}

Methods

disable

enable

Protected factory

get

  • get(id): Promise<Team>

  • Parameters

    • id: string | number

    Returns Promise<Team>

getMany

  • getMany(ids): Promise<Team[]>

  • Parameters

    • ids: string[] | number[]

    Returns Promise<Team[]>

list

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesteamsdisableenablefactorygetgetManylist

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • init: {
        headers: Record<string, string>;
    }
    • headers: Record<string, string>

Returns TeamService

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/groups'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Team> = {}

Static teams

teams: Record<number, Team> = {}

Methods

disable

enable

Protected factory

get

  • get(id): Promise<Team>

  • Parameters

    • id: string | number

    Returns Promise<Team>

getMany

  • getMany(ids): Promise<Team[]>

  • Parameters

    • ids: string[] | number[]

    Returns Promise<Team[]>

list

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesteamsdisableenablefactorygetgetManylist

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Workflow.html b/docs/classes/Workflow.html index 1c4fdc6..ed9b02c 100644 --- a/docs/classes/Workflow.html +++ b/docs/classes/Workflow.html @@ -1,4 +1,4 @@ -Workflow | shortcut-api

Class Workflow

Inherit Doc

Hierarchy

  • default
    • Workflow

Constructors

constructor +Workflow | shortcut-api

Class Workflow

Inherit Doc

Hierarchy

  • default
    • Workflow

Constructors

constructor

Properties

autoAssignOwner changedFields createFields @@ -17,30 +17,30 @@ delete save update -

Constructors

constructor

Properties

autoAssignOwner

autoAssignOwner: boolean

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

-

createFields

createFields: string[] = []

Fields that are used when creating a new resource

-

createdAt

createdAt: Date

defaultStateId

defaultStateId: number

description

description: string

entityType

entityType: string

id

id: number

name

name: string

projectIds

projectIds: number[]

states

states: WorkflowStateInterface[]

teamId

teamId: number

updatedAt

updatedAt: Date

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

The base URL for the API endpoint related to the resource

-

Methods

create

  • create(): Promise<Workflow>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    +

Constructors

constructor

Properties

autoAssignOwner

autoAssignOwner: boolean

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

+

createFields

createFields: string[] = []

Fields that are used when creating a new resource

+

createdAt

createdAt: Date

defaultStateId

defaultStateId: number

description

description: string

entityType

entityType: string

id

id: number

name

name: string

projectIds

projectIds: number[]

states

states: WorkflowStateInterface[]

teamId

teamId: number

updatedAt

updatedAt: Date

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

The base URL for the API endpoint related to the resource

+

Methods

create

  • create(): Promise<Workflow>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    Returns Promise<Workflow>

    • A Promise that resolves with the newly created instance.

    Throws

    • Throws an error if the HTTP request fails.
    -

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    +

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    Returns Promise<void>

    • A Promise that resolves when the resource has been deleted.

    Throws

    • Throws an error if the HTTP request fails.
    -

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. +

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. Otherwise, it will be created using the fields createFields.

    -

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    +

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    Returns Promise<void>

    • A Promise that resolves when the resource has been updated.

    Throws

    • Throws an error if the HTTP request fails.
    -

Settings

Member Visibility

Theme

On This Page

constructorautoAssignOwnerchangedFieldscreateFieldscreatedAtdefaultStateIddescriptionentityTypeidnameprojectIdsstatesteamIdupdatedAtbaseUrlcreatedeletesaveupdate

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorautoAssignOwnerchangedFieldscreateFieldscreatedAtdefaultStateIddescriptionentityTypeidnameprojectIdsstatesteamIdupdatedAtbaseUrlcreatedeletesaveupdate

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/WorkflowsService.html b/docs/classes/WorkflowsService.html index 7ea20c6..44179b8 100644 --- a/docs/classes/WorkflowsService.html +++ b/docs/classes/WorkflowsService.html @@ -1,4 +1,4 @@ -WorkflowsService | shortcut-api

Class WorkflowsService

Hierarchy

Constructors

constructor +WorkflowsService | shortcut-api

Class WorkflowsService

Hierarchy

Constructors

constructor

Properties

baseUrl factory headers @@ -11,4 +11,4 @@ getWorkflowStates getWorkflows

Constructors

constructor

  • new WorkflowsService(init): WorkflowsService

  • Service classes are not intended to be instantiated directly. Instead, use the Client class to create instances of services.

    -

    Parameters

    • init: {
          headers: Record<string, string>;
      }
      • headers: Record<string, string>

    Returns WorkflowsService

Properties

baseUrl

baseUrl: string = ''

Protected factory

factory: ((data) => Workflow)

Type declaration

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Workflow> = {}

Methods

get

getMany

list

Static Private extractWorkflowStates

  • extractWorkflowStates(workflows): WorkflowStateInterface[]

  • Parameters

    • workflows: WorkflowInterface[]

    Returns WorkflowStateInterface[]

Static getWorkflowState

Static getWorkflowStates

Static getWorkflows

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlfactoryheadersinstancesgetgetManylistextractWorkflowStatesgetWorkflowStategetWorkflowStatesgetWorkflows

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • init: {
        headers: Record<string, string>;
    }
    • headers: Record<string, string>

Returns WorkflowsService

Properties

baseUrl

baseUrl: string = ''

Protected factory

factory: ((data) => Workflow)

Type declaration

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Workflow> = {}

Methods

get

getMany

list

Static Private extractWorkflowStates

  • extractWorkflowStates(workflows): WorkflowStateInterface[]

  • Parameters

    • workflows: WorkflowInterface[]

    Returns WorkflowStateInterface[]

Static getWorkflowState

Static getWorkflowStates

Static getWorkflows

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlfactoryheadersinstancesgetgetManylistextractWorkflowStatesgetWorkflowStategetWorkflowStatesgetWorkflows

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/coverage.svg b/docs/coverage.svg index 3d573e1..5c65809 100644 --- a/docs/coverage.svg +++ b/docs/coverage.svg @@ -11,7 +11,7 @@ Docs Docs - 20% - 20% + 18% + 18% \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index f2d708d..c173d00 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,5 +1,7 @@ shortcut-api

shortcut-api

References

default

Classes

Client +Epic +EpicsService Iteration IterationsService Member diff --git a/src/index.ts b/src/index.ts index 5320d9e..a4e519e 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,6 +4,7 @@ import Member from '@sx/members/member' import Story from '@sx/stories/story' import Team from '@sx/teams/team' import Workflow from '@sx/workflows/workflow' +import Epic from '@sx/epics/epic' // Services import StoriesService from '@sx/stories/stories-service' @@ -11,7 +12,8 @@ import IterationsService from '@sx/iterations/iterations-service' import TeamService from '@sx/teams/team-service' import MembersService from '@sx/members/members-service' import WorkflowsService from '@sx/workflows/workflows-service' +import EpicsService from '@sx/epics/epics-service' export default Client -export {Client, Iteration, Member, Story, Team, Workflow} -export {StoriesService, IterationsService, TeamService, MembersService, WorkflowsService} \ No newline at end of file +export {Client, Iteration, Member, Story, Team, Workflow, Epic} +export {StoriesService, IterationsService, TeamService, MembersService, WorkflowsService, EpicsService} \ No newline at end of file From 8191f897a43d76e353968daafefba8f349c6343c Mon Sep 17 00:00:00 2001 From: Jens Astrup Date: Thu, 28 Mar 2024 19:04:31 -0400 Subject: [PATCH 2/2] Add epic to docs --- docs/classes/Epic.html | 74 ++++++++++++++++++++++++++++++++++ docs/classes/EpicsService.html | 11 +++++ 2 files changed, 85 insertions(+) create mode 100644 docs/classes/Epic.html create mode 100644 docs/classes/EpicsService.html diff --git a/docs/classes/Epic.html b/docs/classes/Epic.html new file mode 100644 index 0000000..44ab51c --- /dev/null +++ b/docs/classes/Epic.html @@ -0,0 +1,74 @@ +Epic | shortcut-api

Class Epic

Hierarchy

  • default
    • Epic

Constructors

constructor +

Properties

appUrl +archived +associatedGroups +changedFields +completed +completedAt +completedAtOverride +createFields +deadline +description +entityType +epicStateId +externalId +followerIds +groupIds +id +labelIds +labels +memberMentionIds +mentionIds +milestoneId +name +objectiveIds +ownerIds +plannedStartDate +position +productboardId +productboardName +productboardPluginId +productboardUrl +projectIds +requestedById +started +startedAt +startedAtOverride +stats +storiesWithoutProjects +updatedAt +baseUrl +

Accessors

followers +teams +

Methods

create +delete +save +update +

Constructors

constructor

  • new Epic(init): Epic

  • Parameters

    • init: object | default

    Returns Epic

Properties

appUrl

appUrl: string

archived

archived: boolean

associatedGroups

associatedGroups: []

Protected Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update

+

completed

completed: boolean

completedAt

completedAt: null | string

completedAtOverride

completedAtOverride: null | string

createFields

createFields: string[] = []

Fields that are used when creating a new resource

+

deadline

deadline: null | string

description

description: string

entityType

entityType: string

epicStateId

epicStateId: number

externalId

externalId: null | string

followerIds

followerIds: string[]

groupIds

groupIds: string[]

id

id: number

labelIds

labelIds: number[]

labels

labels: []

memberMentionIds

memberMentionIds: string[]

mentionIds

mentionIds: string[]

milestoneId

milestoneId: null | number

name

name: string

objectiveIds

objectiveIds: number[]

ownerIds

ownerIds: string[]

plannedStartDate

plannedStartDate: null | string

position

position: number

productboardId

productboardId: null | string

productboardName

productboardName: null | string

productboardPluginId

productboardPluginId: null | string

productboardUrl

productboardUrl: null | string

projectIds

projectIds: number[]

requestedById

requestedById: string

started

started: boolean

startedAt

startedAt: null | string

startedAtOverride

startedAtOverride: null | string

stats

stats: object

storiesWithoutProjects

storiesWithoutProjects: number

updatedAt

updatedAt: null | string

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/epics'

Accessors

followers

teams

  • get teams(): Promise<Team[]>

  • Get the teams assigned to the story, labelled as "Group" in the Shortcut API

    +

    Returns Promise<Team[]>

Methods

create

  • create(): Promise<Epic>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    +

    Returns Promise<Epic>

      +
    • A Promise that resolves with the newly created instance.
      • +
    +

    Throws

      +
    • Throws an error if the HTTP request fails.
      • +
    +

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    +

    Returns Promise<void>

      +
    • A Promise that resolves when the resource has been deleted.
      • +
    +

    Throws

      +
    • Throws an error if the HTTP request fails.
      • +
    +

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. +Otherwise, it will be created using the fields createFields.

    +

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    +

    Returns Promise<void>

      +
    • A Promise that resolves when the resource has been updated.
      • +
    +

    Throws

      +
    • Throws an error if the HTTP request fails.
      • +
    +

Settings

Member Visibility

Theme

On This Page

constructorappUrlarchivedassociatedGroupschangedFieldscompletedcompletedAtcompletedAtOverridecreateFieldsdeadlinedescriptionentityTypeepicStateIdexternalIdfollowerIdsgroupIdsidlabelIdslabelsmemberMentionIdsmentionIdsmilestoneIdnameobjectiveIdsownerIdsplannedStartDatepositionproductboardIdproductboardNameproductboardPluginIdproductboardUrlprojectIdsrequestedByIdstartedstartedAtstartedAtOverridestatsstoriesWithoutProjectsupdatedAtbaseUrlfollowersteamscreatedeletesaveupdate

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/EpicsService.html b/docs/classes/EpicsService.html new file mode 100644 index 0000000..e5177d4 --- /dev/null +++ b/docs/classes/EpicsService.html @@ -0,0 +1,11 @@ +EpicsService | shortcut-api

Class EpicsService

Hierarchy

  • default<Epic>
    • EpicsService

Constructors

constructor +

Properties

baseUrl +headers +instances +epics +

Methods

factory +get +getMany +list +

Constructors

constructor

  • new EpicsService(init): EpicsService

  • Service classes are not intended to be instantiated directly. Instead, use the Client class to create instances of services.

    +

    Parameters

    • init: {
          headers: Record<string, string>;
      }
      • headers: Record<string, string>

    Returns EpicsService

Properties

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/epics'

headers

headers: Record<string, string>

Protected instances

instances: Record<string, Epic> = {}

Static epics

epics: Record<number, Epic> = {}

Methods

Protected factory

get

  • get(id): Promise<Epic>

  • Parameters

    • id: string | number

    Returns Promise<Epic>

getMany

  • getMany(ids): Promise<Epic[]>

  • Parameters

    • ids: string[] | number[]

    Returns Promise<Epic[]>

list

Settings

Member Visibility

Theme

On This Page

constructorbaseUrlheadersinstancesepicsfactorygetgetManylist

Generated using TypeDoc

\ No newline at end of file