diff --git a/poetry.lock b/poetry.lock index 789f2c5..2c18df0 100644 --- a/poetry.lock +++ b/poetry.lock @@ -136,101 +136,101 @@ files = [ [[package]] name = "charset-normalizer" -version = "3.3.1" +version = "3.3.2" description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." optional = false python-versions = ">=3.7.0" files = [ - {file = "charset-normalizer-3.3.1.tar.gz", hash = "sha256:d9137a876020661972ca6eec0766d81aef8a5627df628b664b234b73396e727e"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:8aee051c89e13565c6bd366813c386939f8e928af93c29fda4af86d25b73d8f8"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:352a88c3df0d1fa886562384b86f9a9e27563d4704ee0e9d56ec6fcd270ea690"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:223b4d54561c01048f657fa6ce41461d5ad8ff128b9678cfe8b2ecd951e3f8a2"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4f861d94c2a450b974b86093c6c027888627b8082f1299dfd5a4bae8e2292821"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1171ef1fc5ab4693c5d151ae0fdad7f7349920eabbaca6271f95969fa0756c2d"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28f512b9a33235545fbbdac6a330a510b63be278a50071a336afc1b78781b147"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c0e842112fe3f1a4ffcf64b06dc4c61a88441c2f02f373367f7b4c1aa9be2ad5"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3f9bc2ce123637a60ebe819f9fccc614da1bcc05798bbbaf2dd4ec91f3e08846"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:f194cce575e59ffe442c10a360182a986535fd90b57f7debfaa5c845c409ecc3"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:9a74041ba0bfa9bc9b9bb2cd3238a6ab3b7618e759b41bd15b5f6ad958d17605"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:b578cbe580e3b41ad17b1c428f382c814b32a6ce90f2d8e39e2e635d49e498d1"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:6db3cfb9b4fcecb4390db154e75b49578c87a3b9979b40cdf90d7e4b945656e1"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:debb633f3f7856f95ad957d9b9c781f8e2c6303ef21724ec94bea2ce2fcbd056"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-win32.whl", hash = "sha256:87071618d3d8ec8b186d53cb6e66955ef2a0e4fa63ccd3709c0c90ac5a43520f"}, - {file = "charset_normalizer-3.3.1-cp310-cp310-win_amd64.whl", hash = "sha256:e372d7dfd154009142631de2d316adad3cc1c36c32a38b16a4751ba78da2a397"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:ae4070f741f8d809075ef697877fd350ecf0b7c5837ed68738607ee0a2c572cf"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:58e875eb7016fd014c0eea46c6fa92b87b62c0cb31b9feae25cbbe62c919f54d"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:dbd95e300367aa0827496fe75a1766d198d34385a58f97683fe6e07f89ca3e3c"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:de0b4caa1c8a21394e8ce971997614a17648f94e1cd0640fbd6b4d14cab13a72"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:985c7965f62f6f32bf432e2681173db41336a9c2611693247069288bcb0c7f8b"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a15c1fe6d26e83fd2e5972425a772cca158eae58b05d4a25a4e474c221053e2d"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ae55d592b02c4349525b6ed8f74c692509e5adffa842e582c0f861751701a673"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:be4d9c2770044a59715eb57c1144dedea7c5d5ae80c68fb9959515037cde2008"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:851cf693fb3aaef71031237cd68699dded198657ec1e76a76eb8be58c03a5d1f"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:31bbaba7218904d2eabecf4feec0d07469284e952a27400f23b6628439439fa7"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:871d045d6ccc181fd863a3cd66ee8e395523ebfbc57f85f91f035f50cee8e3d4"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:501adc5eb6cd5f40a6f77fbd90e5ab915c8fd6e8c614af2db5561e16c600d6f3"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:f5fb672c396d826ca16a022ac04c9dce74e00a1c344f6ad1a0fdc1ba1f332213"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-win32.whl", hash = "sha256:bb06098d019766ca16fc915ecaa455c1f1cd594204e7f840cd6258237b5079a8"}, - {file = "charset_normalizer-3.3.1-cp311-cp311-win_amd64.whl", hash = "sha256:8af5a8917b8af42295e86b64903156b4f110a30dca5f3b5aedea123fbd638bff"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:7ae8e5142dcc7a49168f4055255dbcced01dc1714a90a21f87448dc8d90617d1"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:5b70bab78accbc672f50e878a5b73ca692f45f5b5e25c8066d748c09405e6a55"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5ceca5876032362ae73b83347be8b5dbd2d1faf3358deb38c9c88776779b2e2f"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:34d95638ff3613849f473afc33f65c401a89f3b9528d0d213c7037c398a51296"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9edbe6a5bf8b56a4a84533ba2b2f489d0046e755c29616ef8830f9e7d9cf5728"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f6a02a3c7950cafaadcd46a226ad9e12fc9744652cc69f9e5534f98b47f3bbcf"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:10b8dd31e10f32410751b3430996f9807fc4d1587ca69772e2aa940a82ab571a"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:edc0202099ea1d82844316604e17d2b175044f9bcb6b398aab781eba957224bd"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:b891a2f68e09c5ef989007fac11476ed33c5c9994449a4e2c3386529d703dc8b"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:71ef3b9be10070360f289aea4838c784f8b851be3ba58cf796262b57775c2f14"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:55602981b2dbf8184c098bc10287e8c245e351cd4fdcad050bd7199d5a8bf514"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:46fb9970aa5eeca547d7aa0de5d4b124a288b42eaefac677bde805013c95725c"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:520b7a142d2524f999447b3a0cf95115df81c4f33003c51a6ab637cbda9d0bf4"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-win32.whl", hash = "sha256:8ec8ef42c6cd5856a7613dcd1eaf21e5573b2185263d87d27c8edcae33b62a61"}, - {file = "charset_normalizer-3.3.1-cp312-cp312-win_amd64.whl", hash = "sha256:baec8148d6b8bd5cee1ae138ba658c71f5b03e0d69d5907703e3e1df96db5e41"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:63a6f59e2d01310f754c270e4a257426fe5a591dc487f1983b3bbe793cf6bac6"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1d6bfc32a68bc0933819cfdfe45f9abc3cae3877e1d90aac7259d57e6e0f85b1"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4f3100d86dcd03c03f7e9c3fdb23d92e32abbca07e7c13ebd7ddfbcb06f5991f"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:39b70a6f88eebe239fa775190796d55a33cfb6d36b9ffdd37843f7c4c1b5dc67"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4e12f8ee80aa35e746230a2af83e81bd6b52daa92a8afaef4fea4a2ce9b9f4fa"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7b6cefa579e1237ce198619b76eaa148b71894fb0d6bcf9024460f9bf30fd228"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:61f1e3fb621f5420523abb71f5771a204b33c21d31e7d9d86881b2cffe92c47c"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:4f6e2a839f83a6a76854d12dbebde50e4b1afa63e27761549d006fa53e9aa80e"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:1ec937546cad86d0dce5396748bf392bb7b62a9eeb8c66efac60e947697f0e58"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:82ca51ff0fc5b641a2d4e1cc8c5ff108699b7a56d7f3ad6f6da9dbb6f0145b48"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:633968254f8d421e70f91c6ebe71ed0ab140220469cf87a9857e21c16687c034"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-win32.whl", hash = "sha256:c0c72d34e7de5604df0fde3644cc079feee5e55464967d10b24b1de268deceb9"}, - {file = "charset_normalizer-3.3.1-cp37-cp37m-win_amd64.whl", hash = "sha256:63accd11149c0f9a99e3bc095bbdb5a464862d77a7e309ad5938fbc8721235ae"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5a3580a4fdc4ac05f9e53c57f965e3594b2f99796231380adb2baaab96e22761"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:2465aa50c9299d615d757c1c888bc6fef384b7c4aec81c05a0172b4400f98557"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:cb7cd68814308aade9d0c93c5bd2ade9f9441666f8ba5aa9c2d4b389cb5e2a45"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:91e43805ccafa0a91831f9cd5443aa34528c0c3f2cc48c4cb3d9a7721053874b"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:854cc74367180beb327ab9d00f964f6d91da06450b0855cbbb09187bcdb02de5"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c15070ebf11b8b7fd1bfff7217e9324963c82dbdf6182ff7050519e350e7ad9f"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2c4c99f98fc3a1835af8179dcc9013f93594d0670e2fa80c83aa36346ee763d2"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3fb765362688821404ad6cf86772fc54993ec11577cd5a92ac44b4c2ba52155b"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:dced27917823df984fe0c80a5c4ad75cf58df0fbfae890bc08004cd3888922a2"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a66bcdf19c1a523e41b8e9d53d0cedbfbac2e93c649a2e9502cb26c014d0980c"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:ecd26be9f112c4f96718290c10f4caea6cc798459a3a76636b817a0ed7874e42"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:3f70fd716855cd3b855316b226a1ac8bdb3caf4f7ea96edcccc6f484217c9597"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:17a866d61259c7de1bdadef418a37755050ddb4b922df8b356503234fff7932c"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-win32.whl", hash = "sha256:548eefad783ed787b38cb6f9a574bd8664468cc76d1538215d510a3cd41406cb"}, - {file = "charset_normalizer-3.3.1-cp38-cp38-win_amd64.whl", hash = "sha256:45f053a0ece92c734d874861ffe6e3cc92150e32136dd59ab1fb070575189c97"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:bc791ec3fd0c4309a753f95bb6c749ef0d8ea3aea91f07ee1cf06b7b02118f2f"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:0c8c61fb505c7dad1d251c284e712d4e0372cef3b067f7ddf82a7fa82e1e9a93"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:2c092be3885a1b7899cd85ce24acedc1034199d6fca1483fa2c3a35c86e43041"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c2000c54c395d9e5e44c99dc7c20a64dc371f777faf8bae4919ad3e99ce5253e"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4cb50a0335382aac15c31b61d8531bc9bb657cfd848b1d7158009472189f3d62"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c30187840d36d0ba2893bc3271a36a517a717f9fd383a98e2697ee890a37c273"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fe81b35c33772e56f4b6cf62cf4aedc1762ef7162a31e6ac7fe5e40d0149eb67"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d0bf89afcbcf4d1bb2652f6580e5e55a840fdf87384f6063c4a4f0c95e378656"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:06cf46bdff72f58645434d467bf5228080801298fbba19fe268a01b4534467f5"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:3c66df3f41abee950d6638adc7eac4730a306b022570f71dd0bd6ba53503ab57"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:cd805513198304026bd379d1d516afbf6c3c13f4382134a2c526b8b854da1c2e"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:9505dc359edb6a330efcd2be825fdb73ee3e628d9010597aa1aee5aa63442e97"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:31445f38053476a0c4e6d12b047b08ced81e2c7c712e5a1ad97bc913256f91b2"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-win32.whl", hash = "sha256:bd28b31730f0e982ace8663d108e01199098432a30a4c410d06fe08fdb9e93f4"}, - {file = "charset_normalizer-3.3.1-cp39-cp39-win_amd64.whl", hash = "sha256:555fe186da0068d3354cdf4bbcbc609b0ecae4d04c921cc13e209eece7720727"}, - {file = "charset_normalizer-3.3.1-py3-none-any.whl", hash = "sha256:800561453acdecedaac137bf09cd719c7a440b6800ec182f077bb8e7025fb708"}, + {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"}, + {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, ] [[package]] diff --git a/pyproject.toml b/pyproject.toml index d0971e9..84e3173 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "nonebot-adapter-feishu" -version = "2.3.0" +version = "2.3.1" description = "feishu(larksuite) adapter for nonebot2" authors = ["StarHeartHunt "] license = "MIT" diff --git a/website/versioned_docs/version-2.2.0/api/.gitkeep b/website/versioned_docs/version-2.2.0/api/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/website/versioned_docs/version-2.2.0/api/adapter.md b/website/versioned_docs/version-2.2.0/api/adapter.md deleted file mode 100644 index 16720b9..0000000 --- a/website/versioned_docs/version-2.2.0/api/adapter.md +++ /dev/null @@ -1,97 +0,0 @@ -# nonebot.adapters.feishu.adapter - -## _class_ `Adapter(driver, **kwargs)` {#Adapter} - -- **参数** - - - `driver` (Driver) - - - `**kwargs` (Any) - -### _class-var_ `event_models` {#Adapter-event-models} - -- **类型:** StringTrie - -- **说明:** 所有事件模型索引 - -### _classmethod_ `get_name()` {#Adapter-get-name} - -- **说明:** 适配器名称: `Feishu` - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `setup()` {#Adapter-setup} - -- **参数** - - empty - -- **返回** - - - None - -### _async method_ `get_tenant_access_token(bot_config)` {#Adapter-get-tenant-access-token} - -- **参数** - - - `bot_config` ([BotConfig](config.md#BotConfig)) - -- **返回** - - - str - -### _classmethod_ `json_to_event(json_data)` {#Adapter-json-to-event} - -- **说明:** 将 json 数据转换为 Event 对象。 - -- **参数** - - - `json_data` (Any): json 数据 - - - `self_id`: 当前 Event 对应的 Bot - -- **返回** - - - [Event](event.md#Event) | None: Event 对象，如果解析失败则返回 None - -### _classmethod_ `add_custom_model(model)` {#Adapter-add-custom-model} - -- **说明:** 插入或覆盖一个自定义的 Event 类型。 需提供 `__event__` 属性，进行事件模型索引， 格式为 `{post_type}[.{sub_type}]`，如: `message.private`。 - -- **参数** - - - `model` (type[[Event](event.md#Event)]): 自定义的 Event 类型 - -- **返回** - - - None - -### _classmethod_ `get_event_model(event_name)` {#Adapter-get-event-model} - -- **说明:** 根据事件名获取对应 `Event Model` 及 `FallBack Event Model` 列表， 不包括基类 `Event`。 - -- **参数** - - - `event_name` (str) - -- **返回** - - - list[type[[Event](event.md#Event)]] - -### _classmethod_ `custom_send(send_func)` {#Adapter-custom-send} - -- **说明:** 自定义 Bot 的回复函数。 - -- **参数** - - - `send_func` (([Bot](bot.md#Bot), [Event](event.md#Event), str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)) -> Any) - -- **返回** - - - untyped diff --git a/website/versioned_docs/version-2.2.0/api/bot.md b/website/versioned_docs/version-2.2.0/api/bot.md deleted file mode 100644 index 4cecffc..0000000 --- a/website/versioned_docs/version-2.2.0/api/bot.md +++ /dev/null @@ -1,107 +0,0 @@ -# nonebot.adapters.feishu.bot - -## _async def_ `send(bot, event, message, at_sender=False, **kwargs)` {#send} - -- **说明:** 默认回复消息处理函数。 - -- **参数** - - - `bot` (Bot) - - - `event` ([Event](event.md#Event)) - - - `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)) - - - `at_sender` (bool) - - - `**kwargs` (Any) - -- **返回** - - - Any - -## _class_ `BotInfo()` {#BotInfo} - -- **参数** - - auto - -## _class_ `Bot(adapter, self_id, *, bot_config, bot_info)` {#Bot} - -- **参数** - - - `adapter` ([Adapter](adapter.md#Adapter)) - - - `self_id` (str) - - - `bot_config` ([BotConfig](config.md#BotConfig)) - - - `bot_info` (BotInfo) - -### _async method_ `send_handler(event, message, at_sender=False, **kwargs)` {#Bot-send-handler} - -- **说明:** 默认回复消息处理函数。 - -- **参数** - - - `event` ([Event](event.md#Event)) - - - `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)) - - - `at_sender` (bool) - - - `**kwargs` (Any) - -- **返回** - - - Any - -### _async method_ `send(event, message, **kwargs)` {#Bot-send} - -- **说明:** 根据 `event` 向触发事件的主体回复消息。 - -- **参数** - - - `event` ([Event](event.md#Event)): Event 对象 - - - `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)): 要发送的消息 - - - `at_sender` (bool): 是否 @ 事件主体 - - - `**kwargs` (Any): 其他参数，可以与 [Adapter.custom_send](adapter.md#Adapter-custom-send) 配合使用 - -- **返回** - - - Any: API 调用返回数据 - -- **异常** - - - ValueError: 缺少 `user_id`, `group_id` - - - NetworkError: 网络错误 - - - ActionFailed: API 调用失败 - -### _async method_ `call_api(api, **data)` {#Bot-call-api} - -- **说明:** :说明: 调用 飞书 协议 API :参数: _ `api: str`: API 名称 _ `**data: Any`: API 参数 :返回: - `Any`: API 调用返回数据 :异常: - `NetworkError`: 网络错误 - `ActionFailed`: API 调用失败 - -- **参数** - - - `api` (str) - - - `**data` - -- **返回** - - - Any - -### _async method_ `handle_event(event)` {#Bot-handle-event} - -- **参数** - - - `event` ([Event](event.md#Event)) - -- **返回** - - - None diff --git a/website/versioned_docs/version-2.2.0/api/config.md b/website/versioned_docs/version-2.2.0/api/config.md deleted file mode 100644 index 641535f..0000000 --- a/website/versioned_docs/version-2.2.0/api/config.md +++ /dev/null @@ -1,35 +0,0 @@ -# nonebot.adapters.feishu.config - -## _class_ `BotConfig()` {#BotConfig} - -- **说明** - - 飞书适配器机器人配置类 - - :配置项: - - - `app_id`: 飞书开放平台后台“凭证与基础信息”处给出的 App ID - - `app_secret`: 飞书开放平台后台“凭证与基础信息”处给出的 App Secret - - `encrypt_key`: 飞书开放平台后台“事件订阅”处设置的 Encrypt Key - - `verification_token`: 飞书开放平台后台“事件订阅”处设置的 Verification Token - - `is_lark`: 是否使用 Lark（飞书海外版），默认为 false - -- **参数** - - auto - -## _class_ `Config()` {#Config} - -- **说明** - - 飞书适配器全局配置类 - - :配置项: - - - `feishu_api_base`: 飞书国内版开放平台 API Endpoint - - `feishu_lark_api_base`: 飞书海外版（lark）开放平台 API Endpoint - - `feishu_bots`: 飞书适配器 Bot 配置列表，具体配置项参阅 BotConfig 类 - -- **参数** - - auto diff --git a/website/versioned_docs/version-2.2.0/api/event.md b/website/versioned_docs/version-2.2.0/api/event.md deleted file mode 100644 index 2c771da..0000000 --- a/website/versioned_docs/version-2.2.0/api/event.md +++ /dev/null @@ -1,540 +0,0 @@ -# nonebot.adapters.feishu.event - -## _class_ `Event()` {#Event} - -- **说明** - - 飞书协议事件。各事件字段参考 `飞书文档`\_ - - .. \_飞书文档: - https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list - -- **参数** - - auto - -### _method_ `get_type()` {#Event-get-type} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_event_name()` {#Event-get-event-name} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_event_description()` {#Event-get-event-description} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_message()` {#Event-get-message} - -- **参数** - - empty - -- **返回** - - - [Message](message.md#Message) - -### _method_ `get_plaintext()` {#Event-get-plaintext} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_user_id()` {#Event-get-user-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_session_id()` {#Event-get-session-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `is_tome()` {#Event-is-tome} - -- **参数** - - empty - -- **返回** - - - bool - -## _class_ `MessageEvent()` {#MessageEvent} - -- **参数** - - auto - -### _class-var_ `to_me` {#MessageEvent-to-me} - -- **类型:** bool - -- **说明** - - :说明: 消息是否与机器人有关 - - :类型: `bool` - -### _method_ `get_type()` {#MessageEvent-get-type} - -- **参数** - - empty - -- **返回** - - - Literal['message'] - -### _method_ `get_event_name()` {#MessageEvent-get-event-name} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_event_description()` {#MessageEvent-get-event-description} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_message()` {#MessageEvent-get-message} - -- **参数** - - empty - -- **返回** - - - [Message](message.md#Message) - -### _method_ `get_plaintext()` {#MessageEvent-get-plaintext} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_user_id()` {#MessageEvent-get-user-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_all_user_id()` {#MessageEvent-get-all-user-id} - -- **参数** - - empty - -- **返回** - - - UserId - -### _method_ `get_session_id()` {#MessageEvent-get-session-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `is_tome()` {#MessageEvent-is-tome} - -- **参数** - - empty - -- **返回** - - - bool - -## _class_ `GroupMessageEvent()` {#GroupMessageEvent} - -- **参数** - - auto - -## _class_ `PrivateMessageEvent()` {#PrivateMessageEvent} - -- **参数** - - auto - -## _class_ `NoticeEvent()` {#NoticeEvent} - -- **参数** - - auto - -### _method_ `get_type()` {#NoticeEvent-get-type} - -- **参数** - - empty - -- **返回** - - - Literal['notice'] - -### _method_ `get_event_name()` {#NoticeEvent-get-event-name} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_event_description()` {#NoticeEvent-get-event-description} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_message()` {#NoticeEvent-get-message} - -- **参数** - - empty - -- **返回** - - - [Message](message.md#Message) - -### _method_ `get_plaintext()` {#NoticeEvent-get-plaintext} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_user_id()` {#NoticeEvent-get-user-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_session_id()` {#NoticeEvent-get-session-id} - -- **参数** - - empty - -- **返回** - - - str - -## _class_ `MessageReadEvent()` {#MessageReadEvent} - -- **参数** - - auto - -## _class_ `GroupDisbandedEvent()` {#GroupDisbandedEvent} - -- **参数** - - auto - -## _class_ `MessageReactionDeletedEvent()` {#MessageReactionDeletedEvent} - -- **参数** - - auto - -## _class_ `MessageReactionCreatedEvent()` {#MessageReactionCreatedEvent} - -- **参数** - - auto - -## _class_ `GroupConfigUpdatedEvent()` {#GroupConfigUpdatedEvent} - -- **参数** - - auto - -## _class_ `GroupMemberBotAddedEvent()` {#GroupMemberBotAddedEvent} - -- **参数** - - auto - -## _class_ `GroupMemberBotDeletedEvent()` {#GroupMemberBotDeletedEvent} - -- **参数** - - auto - -## _class_ `GroupMemberUserAddedEvent()` {#GroupMemberUserAddedEvent} - -- **参数** - - auto - -## _class_ `GroupMemberUserWithdrawnEvent()` {#GroupMemberUserWithdrawnEvent} - -- **参数** - - auto - -## _class_ `GroupMemberUserDeletedEvent()` {#GroupMemberUserDeletedEvent} - -- **参数** - - auto - -## _class_ `ContactUserUpdatedEvent()` {#ContactUserUpdatedEvent} - -- **参数** - - auto - -## _class_ `ContactUserDeletedEvent()` {#ContactUserDeletedEvent} - -- **参数** - - auto - -## _class_ `ContactUserCreatedEvent()` {#ContactUserCreatedEvent} - -- **参数** - - auto - -## _class_ `ContactDepartmentUpdatedEvent()` {#ContactDepartmentUpdatedEvent} - -- **参数** - - auto - -## _class_ `ContactDepartmentDeletedEvent()` {#ContactDepartmentDeletedEvent} - -- **参数** - - auto - -## _class_ `ContactDepartmentCreatedEvent()` {#ContactDepartmentCreatedEvent} - -- **参数** - - auto - -## _class_ `CalendarAclCreatedEvent()` {#CalendarAclCreatedEvent} - -- **参数** - - auto - -## _class_ `CalendarAclDeletedEvent()` {#CalendarAclDeletedEvent} - -- **参数** - - auto - -## _class_ `CalendarChangedEvent()` {#CalendarChangedEvent} - -- **参数** - - auto - -## _class_ `CalendarEventChangedEvent()` {#CalendarEventChangedEvent} - -- **参数** - - auto - -## _class_ `DriveFileReadEvent()` {#DriveFileReadEvent} - -- **参数** - - auto - -## _class_ `DriveFileTitleUpdatedEvent()` {#DriveFileTitleUpdatedEvent} - -- **参数** - - auto - -## _class_ `DriveFilePermissionMemberAddedEvent()` {#DriveFilePermissionMemberAddedEvent} - -- **参数** - - auto - -## _class_ `DriveFilePermissionMemberRemovedEvent()` {#DriveFilePermissionMemberRemovedEvent} - -- **参数** - - auto - -## _class_ `DriveFileTrashedEvent()` {#DriveFileTrashedEvent} - -- **参数** - - auto - -## _class_ `DriveFileDeletedEvent()` {#DriveFileDeletedEvent} - -- **参数** - - auto - -## _class_ `DriveFileEditedEvent()` {#DriveFileEditedEvent} - -- **参数** - - auto - -## _class_ `MeetingRoomCreatedEvent()` {#MeetingRoomCreatedEvent} - -- **参数** - - auto - -## _class_ `MeetingRoomUpdatedEvent()` {#MeetingRoomUpdatedEvent} - -- **参数** - - auto - -## _class_ `MeetingRoomDeletedEvent()` {#MeetingRoomDeletedEvent} - -- **参数** - - auto - -## _class_ `MeetingRoomStatusChangedEvent()` {#MeetingRoomStatusChangedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingStartedEvent()` {#VCMeetingStartedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingEndedEvent()` {#VCMeetingEndedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingJoinedEvent()` {#VCMeetingJoinedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingLeftEvent()` {#VCMeetingLeftEvent} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingStartedEvent()` {#VCMeetingRecordingStartedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingEndedEvent()` {#VCMeetingRecordingEndedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingReadyEvent()` {#VCMeetingRecordingReadyEvent} - -- **参数** - - auto - -## _class_ `VCMeetingShareStartedEvent()` {#VCMeetingShareStartedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingShareEndedEvent()` {#VCMeetingShareEndedEvent} - -- **参数** - - auto - -## _class_ `AttendanceUserFlowCreatedEvent()` {#AttendanceUserFlowCreatedEvent} - -- **参数** - - auto - -## _class_ `AttendanceUserTaskUpdatedEvent()` {#AttendanceUserTaskUpdatedEvent} - -- **参数** - - auto diff --git a/website/versioned_docs/version-2.2.0/api/exception.md b/website/versioned_docs/version-2.2.0/api/exception.md deleted file mode 100644 index 9e5a234..0000000 --- a/website/versioned_docs/version-2.2.0/api/exception.md +++ /dev/null @@ -1,45 +0,0 @@ -# nonebot.adapters.feishu.exception - -## _class_ `FeishuAdapterException()` {#FeishuAdapterException} - -- **参数** - - auto - -## _class_ `ActionFailed()` {#ActionFailed} - -- **说明** - - :说明: - - API 请求返回错误信息。 - - :参数: - - - `retcode: Optional[int]`: 错误码 - -- **参数** - - auto - -## _class_ `NetworkError()` {#NetworkError} - -- **说明** - - :说明: - - 网络错误。 - - :参数: - - - `retcode: Optional[int]`: 错误码 - -- **参数** - - auto - -## _class_ `ApiNotAvailable()` {#ApiNotAvailable} - -- **参数** - - auto diff --git a/website/versioned_docs/version-2.2.0/api/index.md b/website/versioned_docs/version-2.2.0/api/index.md deleted file mode 100644 index 6e59ec0..0000000 --- a/website/versioned_docs/version-2.2.0/api/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# nonebot.adapters.feishu - -飞书协议适配 diff --git a/website/versioned_docs/version-2.2.0/api/message.md b/website/versioned_docs/version-2.2.0/api/message.md deleted file mode 100644 index 79b893d..0000000 --- a/website/versioned_docs/version-2.2.0/api/message.md +++ /dev/null @@ -1,543 +0,0 @@ -# nonebot.adapters.feishu.message - -## _class_ `MessageSegment()` {#MessageSegment} - -- **说明:** 飞书 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。 - -- **参数** - - auto - -### _classmethod_ `get_message_class()` {#MessageSegment-get-message-class} - -- **参数** - - empty - -- **返回** - - - type[Message] - -### _method_ `is_text()` {#MessageSegment-is-text} - -- **参数** - - empty - -- **返回** - - - bool - -### _staticmethod_ `text(text)` {#MessageSegment-text} - -- **参数** - - - `text` (str) - -- **返回** - - - Text - -### _staticmethod_ `post(title, content, language="zh_cn")` {#MessageSegment-post} - -- **参数** - - - `title` (str) - - - `content` (list[list[PostMessageNode]]) - - - `language` (str) - -- **返回** - - - Post - -### _staticmethod_ `image(image_key)` {#MessageSegment-image} - -- **参数** - - - `image_key` (str) - -- **返回** - - - Image - -### _staticmethod_ `interactive(header, config, elements=None, i18n_elements=None)` {#MessageSegment-interactive} - -- **参数** - - - `header` (InteractiveHeader) - - - `config` (InteractiveConfig) - - - `elements` (list[dict[str, Any]] | None) - - - `i18n_elements` (list[dict[str, Any]] | None) - -- **返回** - - - untyped - -### _staticmethod_ `interactive_template(template_id, template_variable)` {#MessageSegment-interactive-template} - -- **参数** - - - `template_id` (str) - - - `template_variable` (dict[str, Any]) - -- **返回** - - - InteractiveTemplate - -### _staticmethod_ `todo(task_id, summary, due_time)` {#MessageSegment-todo} - -- **参数** - - - `task_id` (str) - - - `summary` (\_PostData) - - - `due_time` (str) - -- **返回** - - - untyped - -### _staticmethod_ `hongbao(text)` {#MessageSegment-hongbao} - -- **参数** - - - `text` (str) - -- **返回** - - - Hongbao - -### _staticmethod_ `system(template, from_user, to_chatters)` {#MessageSegment-system} - -- **参数** - - - `template` (str) - - - `from_user` (list[str]) - - - `to_chatters` (list[str]) - -- **返回** - - - System - -### _staticmethod_ `location(name, longitude, latitude)` {#MessageSegment-location} - -- **参数** - - - `name` (str) - - - `longitude` (str) - - - `latitude` (str) - -- **返回** - - - Location - -### _staticmethod_ `video_chat(topic, start_time)` {#MessageSegment-video-chat} - -- **参数** - - - `topic` (str) - - - `start_time` (str) - -- **返回** - - - untyped - -### _staticmethod_ `share_chat(chat_id)` {#MessageSegment-share-chat} - -- **参数** - - - `chat_id` (str) - -- **返回** - - - MessageSegment - -### _staticmethod_ `share_user(user_id)` {#MessageSegment-share-user} - -- **参数** - - - `user_id` (str) - -- **返回** - - - MessageSegment - -### _staticmethod_ `audio(file_key, duration=None)` {#MessageSegment-audio} - -- **参数** - - - `file_key` (str) - - - `duration` (int | None) - -- **返回** - - - MessageSegment - -### _staticmethod_ `media(file_key, image_key=None, file_name=None, duration=None)` {#MessageSegment-media} - -- **参数** - - - `file_key` (str) - - - `image_key` (str | None) - - - `file_name` (str | None) - - - `duration` (int | None) - -- **返回** - - - MessageSegment - -### _staticmethod_ `file(file_key, file_name=None)` {#MessageSegment-file} - -- **参数** - - - `file_key` (str) - - - `file_name` (str | None) - -- **返回** - - - MessageSegment - -### _staticmethod_ `folder(file_key, file_name)` {#MessageSegment-folder} - -- **参数** - - - `file_key` (str) - - - `file_name` (str) - -- **返回** - - - MessageSegment - -### _staticmethod_ `sticker(file_key)` {#MessageSegment-sticker} - -- **参数** - - - `file_key` (str) - -- **返回** - - - MessageSegment - -### _method_ `to_post()` {#MessageSegment-to-post} - -- **参数** - - empty - -- **返回** - - - untyped - -## _class_ `Text()` {#Text} - -- **说明:** Text(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `At()` {#At} - -- **说明:** At(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `AtAll()` {#AtAll} - -- **说明:** AtAll(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Image()` {#Image} - -- **说明:** Image(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `InteractiveHeaderTitle()` {#InteractiveHeaderTitle} - -- **参数** - - auto - -## _class_ `InteractiveHeader()` {#InteractiveHeader} - -- **参数** - - auto - -## _class_ `InteractiveConfig()` {#InteractiveConfig} - -- **参数** - - auto - -## _class_ `Interactive()` {#Interactive} - -- **参数** - - auto - -## _class_ `InteractiveTemplate()` {#InteractiveTemplate} - -- **说明:** InteractiveTemplate(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `ShareChat()` {#ShareChat} - -- **说明:** ShareChat(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `ShareUser()` {#ShareUser} - -- **说明:** ShareUser(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Audio()` {#Audio} - -- **说明:** Audio(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Media()` {#Media} - -- **说明:** Media(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `File()` {#File} - -- **说明:** File(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Folder()` {#Folder} - -- **说明:** Folder(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Sticker()` {#Sticker} - -- **说明:** Sticker(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `PostMessageNode()` {#PostMessageNode} - -- **参数** - - auto - -## _class_ `PostMessageNodeStylable()` {#PostMessageNodeStylable} - -- **参数** - - auto - -## _class_ `PostText()` {#PostText} - -- **参数** - - auto - -## _class_ `PostA()` {#PostA} - -- **参数** - - auto - -## _class_ `PostAt()` {#PostAt} - -- **参数** - - auto - -## _class_ `PostImg()` {#PostImg} - -- **参数** - - auto - -## _class_ `PostMedia()` {#PostMedia} - -- **参数** - - auto - -## _class_ `PostEmotion()` {#PostEmotion} - -- **参数** - - auto - -## _class_ `Post()` {#Post} - -- **说明:** Post(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `System()` {#System} - -- **说明:** System(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Location()` {#Location} - -- **说明:** Location(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `VideoChat()` {#VideoChat} - -- **说明:** VideoChat(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Todo()` {#Todo} - -- **说明:** Todo(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Vote()` {#Vote} - -- **说明:** Vote(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Hongbao()` {#Hongbao} - -- **说明:** Hongbao(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `ShareCalendarEvent()` {#ShareCalendarEvent} - -- **说明:** ShareCalendarEvent(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Calendar()` {#Calendar} - -- **参数** - - auto - -## _class_ `GeneralCalendar()` {#GeneralCalendar} - -- **参数** - - auto - -## _class_ `Message()` {#Message} - -- **说明:** 飞书 协议 Message 适配。 - -- **参数** - - auto - -### _classmethod_ `get_segment_class()` {#Message-get-segment-class} - -- **参数** - - empty - -- **返回** - - - type[MessageSegment] - -### _method_ `serialize()` {#Message-serialize} - -- **参数** - - empty - -- **返回** - - - tuple[str, str] - -### _staticmethod_ `deserialize(content, mentions, message_type)` {#Message-deserialize} - -- **参数** - - - `content` (str) - - - `mentions` (list[Mention] | None) - - - `message_type` (str) - -- **返回** - - - Message - -### _method_ `extract_plain_text()` {#Message-extract-plain-text} - -- **参数** - - empty - -- **返回** - - - str diff --git a/website/versioned_docs/version-2.2.0/api/models/common.md b/website/versioned_docs/version-2.2.0/api/models/common.md deleted file mode 100644 index 014f8a0..0000000 --- a/website/versioned_docs/version-2.2.0/api/models/common.md +++ /dev/null @@ -1,457 +0,0 @@ -# nonebot.adapters.feishu.models.common - -## _class_ `EventHeader()` {#EventHeader} - -- **参数** - - auto - -## _class_ `UserId()` {#UserId} - -- **参数** - - auto - -## _class_ `MeetingUser()` {#MeetingUser} - -- **参数** - - auto - -## _class_ `Meeting()` {#Meeting} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingReadyEventDetail()` {#VCMeetingRecordingReadyEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingEndedEventDetail()` {#VCMeetingRecordingEndedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingStartedEventDetail()` {#VCMeetingRecordingStartedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingLeftEventDetail()` {#VCMeetingLeftEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingJoinedEventDetail()` {#VCMeetingJoinedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingEndedEventDetail()` {#VCMeetingEndedEventDetail} - -- **参数** - - auto - -## _class_ `Sender()` {#Sender} - -- **参数** - - auto - -## _class_ `ReplySender()` {#ReplySender} - -- **参数** - - auto - -## _class_ `Mention()` {#Mention} - -- **参数** - - auto - -## _class_ `ReplyMention()` {#ReplyMention} - -- **参数** - - auto - -## _class_ `MessageBody()` {#MessageBody} - -- **参数** - - auto - -## _class_ `Reply()` {#Reply} - -- **参数** - - auto - -## _class_ `EventMessage()` {#EventMessage} - -- **参数** - - auto - -## _class_ `GroupEventMessage()` {#GroupEventMessage} - -- **参数** - - auto - -## _class_ `PrivateEventMessage()` {#PrivateEventMessage} - -- **参数** - - auto - -## _class_ `MessageEventDetail()` {#MessageEventDetail} - -- **参数** - - auto - -## _class_ `GroupMessageEventDetail()` {#GroupMessageEventDetail} - -- **参数** - - auto - -## _class_ `PrivateMessageEventDetail()` {#PrivateMessageEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingShareStartedEventDetail()` {#VCMeetingShareStartedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingShareEndedEventDetail()` {#VCMeetingShareEndedEventDetail} - -- **参数** - - auto - -## _class_ `AttendanceUserFlowCreatedEventDetail()` {#AttendanceUserFlowCreatedEventDetail} - -- **参数** - - auto - -## _class_ `AttendanceUserTaskStatusDiff()` {#AttendanceUserTaskStatusDiff} - -- **参数** - - auto - -## _class_ `AttendanceUserTaskUpdatedEventDetail()` {#AttendanceUserTaskUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingStartedEventDetail()` {#VCMeetingStartedEventDetail} - -- **参数** - - auto - -## _class_ `MeetingRoomStatusChangedEventDetail()` {#MeetingRoomStatusChangedEventDetail} - -- **参数** - - auto - -## _class_ `MeetingRoomDeletedEventDetail()` {#MeetingRoomDeletedEventDetail} - -- **参数** - - auto - -## _class_ `MeetingRoomUpdatedEventDetail()` {#MeetingRoomUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `MeetingRoomCreatedEventDetail()` {#MeetingRoomCreatedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileEditedEventDetail()` {#DriveFileEditedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileDeletedEventDetail()` {#DriveFileDeletedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileTrashedEventDetail()` {#DriveFileTrashedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFilePermissionMemberRemovedEventDetail()` {#DriveFilePermissionMemberRemovedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFilePermissionMemberAddedEventDetail()` {#DriveFilePermissionMemberAddedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileTitleUpdatedEventDetail()` {#DriveFileTitleUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileReadEventDetail()` {#DriveFileReadEventDetail} - -- **参数** - - auto - -## _class_ `CalendarEventChangedEventDetail()` {#CalendarEventChangedEventDetail} - -- **参数** - - auto - -## _class_ `CalendarAclScope()` {#CalendarAclScope} - -- **参数** - - auto - -## _class_ `CalendarAclDeletedEventDetail()` {#CalendarAclDeletedEventDetail} - -- **参数** - - auto - -## _class_ `CalendarAclCreatedEventDetail()` {#CalendarAclCreatedEventDetail} - -- **参数** - - auto - -## _class_ `ContactDepartmentStatus()` {#ContactDepartmentStatus} - -- **参数** - - auto - -## _class_ `ContactDepartment()` {#ContactDepartment} - -- **参数** - - auto - -## _class_ `ContactDepartmentCreatedEventDetail()` {#ContactDepartmentCreatedEventDetail} - -- **参数** - - auto - -## _class_ `OldContactDepartment()` {#OldContactDepartment} - -- **参数** - - auto - -## _class_ `ContactDepartmentDeletedEventDetail()` {#ContactDepartmentDeletedEventDetail} - -- **参数** - - auto - -## _class_ `ContactDepartmentUpdatedEventDetail()` {#ContactDepartmentUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `AvatarInfo()` {#AvatarInfo} - -- **参数** - - auto - -## _class_ `UserStatus()` {#UserStatus} - -- **参数** - - auto - -## _class_ `UserOrder()` {#UserOrder} - -- **参数** - - auto - -## _class_ `UserCustomAttrValue()` {#UserCustomAttrValue} - -- **参数** - - auto - -## _class_ `UserCustomAttr()` {#UserCustomAttr} - -- **参数** - - auto - -## _class_ `ContactUser()` {#ContactUser} - -- **参数** - - auto - -## _class_ `OldContactUser()` {#OldContactUser} - -- **参数** - - auto - -## _class_ `ContactUserCreatedEventDetail()` {#ContactUserCreatedEventDetail} - -- **参数** - - auto - -## _class_ `ContactUserDeletedEventDetail()` {#ContactUserDeletedEventDetail} - -- **参数** - - auto - -## _class_ `ContactUserUpdatedEventDetail()` {#ContactUserUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `ChatMemberUser()` {#ChatMemberUser} - -- **参数** - - auto - -## _class_ `GroupMemberUserDeletedEventDetail()` {#GroupMemberUserDeletedEventDetail} - -- **参数** - - auto - -## _class_ `GroupMemberUserWithdrawnEventDetail()` {#GroupMemberUserWithdrawnEventDetail} - -- **参数** - - auto - -## _class_ `GroupMemberUserAddedEventDetail()` {#GroupMemberUserAddedEventDetail} - -- **参数** - - auto - -## _class_ `GroupMemberBotDeletedEventDetail()` {#GroupMemberBotDeletedEventDetail} - -- **参数** - - auto - -## _class_ `GroupMemberBotAddedEventDetail()` {#GroupMemberBotAddedEventDetail} - -- **参数** - - auto - -## _class_ `I18nNames()` {#I18nNames} - -- **参数** - - auto - -## _class_ `Emoji()` {#Emoji} - -- **参数** - - auto - -## _class_ `ChatChange()` {#ChatChange} - -- **参数** - - auto - -## _class_ `EventModerator()` {#EventModerator} - -- **参数** - - auto - -## _class_ `ModeratorList()` {#ModeratorList} - -- **参数** - - auto - -## _class_ `GroupConfigUpdatedEventDetail()` {#GroupConfigUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `MessageReactionCreatedEventDetail()` {#MessageReactionCreatedEventDetail} - -- **参数** - - auto - -## _class_ `MessageReactionDeletedEventDetail()` {#MessageReactionDeletedEventDetail} - -- **参数** - - auto - -## _class_ `GroupDisbandedEventDetail()` {#GroupDisbandedEventDetail} - -- **参数** - - auto - -## _class_ `MessageReader()` {#MessageReader} - -- **参数** - - auto - -## _class_ `MessageReadEventDetail()` {#MessageReadEventDetail} - -- **参数** - - auto diff --git a/website/versioned_docs/version-2.2.0/api/models/index.md b/website/versioned_docs/version-2.2.0/api/models/index.md deleted file mode 100644 index 5905810..0000000 --- a/website/versioned_docs/version-2.2.0/api/models/index.md +++ /dev/null @@ -1 +0,0 @@ -# nonebot.adapters.feishu.models diff --git a/website/versioned_docs/version-2.2.0/api/utils.md b/website/versioned_docs/version-2.2.0/api/utils.md deleted file mode 100644 index 118ec48..0000000 --- a/website/versioned_docs/version-2.2.0/api/utils.md +++ /dev/null @@ -1,47 +0,0 @@ -# nonebot.adapters.feishu.utils - -## _def_ `log()` {#log} - -- **参数** - - auto - -- **返回** - - - untyped - -## _class_ `AESCipher(key)` {#AESCipher} - -- **参数** - - - `key` - -### _staticmethod_ `str_to_bytes(data)` {#AESCipher-str-to-bytes} - -- **参数** - - - `data` - -- **返回** - - - untyped - -### _method_ `decrypt(enc)` {#AESCipher-decrypt} - -- **参数** - - - `enc` - -- **返回** - - - untyped - -### _method_ `decrypt_string(enc)` {#AESCipher-decrypt-string} - -- **参数** - - - `enc` - -- **返回** - - - untyped diff --git a/website/versioned_docs/version-2.2.0/guide/README.md b/website/versioned_docs/version-2.2.0/guide/README.md deleted file mode 100644 index 5e1c0d7..0000000 --- a/website/versioned_docs/version-2.2.0/guide/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 0 -id: index -description: 飞书适配器概览 - -slug: /guide/ ---- - -# 概览 diff --git a/website/versioned_docs/version-2.2.0/guide/installation.md b/website/versioned_docs/version-2.2.0/guide/installation.md deleted file mode 100644 index 860b0b6..0000000 --- a/website/versioned_docs/version-2.2.0/guide/installation.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -sidebar_position: 1 -description: 安装 - -options: - menu: - - category: guide - weight: 20 ---- - -# 安装飞书适配器 - -```bash -pip install nonebot-adapter-feishu -``` - -## 注册飞书适配器 - -在 `bot.py` 中添加： - -```python title=bot.py {2,7} -import nonebot -from nonebot.adapters.feishu import Adapter as FeishuAdapter - -nonebot.init() - -driver = nonebot.get_driver() -driver.register_adapter(FeishuAdapter) -``` diff --git a/website/versioned_docs/version-2.2.0/guide/setup.md b/website/versioned_docs/version-2.2.0/guide/setup.md deleted file mode 100644 index 8480fa1..0000000 --- a/website/versioned_docs/version-2.2.0/guide/setup.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -sidebar_position: 2 -description: 配置连接 - -options: - menu: - - category: guide - weight: 30 ---- - -# 配置连接 - -## 创建应用与启用应用“机器人”能力 - -:::tip 提示 -此部分可参考[飞书开放平台-快速开发机器人-创建应用](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)部分的文档。 - -::: - -## 在 NoneBot 配置文件中添加相应配置 - -复制所创建应用**“凭证和基础信息”**中的 **App ID** 、 **App Secret** 和 **“事件订阅”** 中的 **Verification Token** ，替换以下配置模板中的值。 - -如果在飞书开发者后台的事件订阅中配置了事件上报的 Encrypt Key，也需要传入 FEISHU_BOTS 中。 - -当 `encrypt_key` 存在且不为空时，飞书适配器会认为用户启用了加密机制，并对事件上报中的密文进行解密。 - -如果不需要启用加密功能，请将配置项中的 `encrypt_key` 键值对删去，或将 `encrypt_key` 置为 `null`。 - -对于[Lark(飞书平台海外版)](https://www.larksuite.com) 的用户，飞书适配器也提供**实验性**支持，仅需要在配置文件中将 `is_lark` 改为 `true`。 - -```bash -FEISHU_BOTS=' -[ - { - "app_id": "", - "app_secret": "", - "verification_token": "", - "encrypt_key": "", - "is_lark": false - } -] -' -``` - -飞书适配器支持同时传入多份配置，仅需要按相同格式传入 `FEISHU_BOTS` 即可。 - -```bash -FEISHU_BOTS=' -[ - { - "app_id": "", - "app_secret": "", - "verification_token": "", - "encrypt_key": "", - "is_lark": false - }, - { - "app_id": "", - "app_secret": "", - "verification_token": "", - "encrypt_key": "", - "is_lark": false - } -] -``` - -## 开启应用权限 - -应用拥有所需权限后，才能调用飞书接口获取相关信息。如果需要用到所有飞书平台的 API，请开启所有应用权限。 - -在仅群聊功能的情况下，需要为应用开启用户、消息、通讯录和群聊权限组所有权限，并且启用机器人角色以便获取机器人昵称。 - -## 配置飞书事件订阅 - -### 配置上报地址 - -飞书适配器会自动注册以下地址作为事件订阅上报入口点。 - -由于飞书开放平台的事件订阅并不会上报 App ID，在填写事件订阅请求网址时，请按照如下格式填写，对应的以 `$` 开头的变量请使用 `.env.*` 文件中所定义的值进行替换，`$app_id` 替换为飞书开放平台提供的 App ID。 - -```bash -http://$HOST:$PORT/feishu/$app_id -``` - -### 配置事件订阅列表 - -:::tip 提示 - -在添加事件订阅时请注意，带有**（历史版本）**字样的事件的格式为**不受支持的旧版事件格式**，请使用对应的**新版事件（不带历史版本字样）作为替代**。 - -::: - -## 编写一个适用于飞书适配器的插件并加载 - -插件代码范例： - -```python -from nonebot.plugin import on_command -from nonebot.typing import T_State -from nonebot.adapters.feishu import Bot as FeishuBot, MessageEvent - -helper = on_command("say") - - -@helper.handle() -async def feishu_helper( - bot: FeishuBot, - event: MessageEvent, - state: T_State, - command_arg: Message = CommandArg(), -): - await helper.finish(command_arg, at_sender=True) -``` - -以上代码注册了一个对飞书平台适用的 `say` 指令，并会提取 `/say` 之后的内容发送到事件所对应的群或私聊。 - -大功告成！现在可以试试向机器人发送类似 `/say Hello, Feishu!` 的消息进行测试了。 diff --git a/website/versioned_docs/version-2.2.1/api/.gitkeep b/website/versioned_docs/version-2.2.1/api/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/website/versioned_docs/version-2.2.1/api/adapter.md b/website/versioned_docs/version-2.2.1/api/adapter.md deleted file mode 100644 index 16720b9..0000000 --- a/website/versioned_docs/version-2.2.1/api/adapter.md +++ /dev/null @@ -1,97 +0,0 @@ -# nonebot.adapters.feishu.adapter - -## _class_ `Adapter(driver, **kwargs)` {#Adapter} - -- **参数** - - - `driver` (Driver) - - - `**kwargs` (Any) - -### _class-var_ `event_models` {#Adapter-event-models} - -- **类型:** StringTrie - -- **说明:** 所有事件模型索引 - -### _classmethod_ `get_name()` {#Adapter-get-name} - -- **说明:** 适配器名称: `Feishu` - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `setup()` {#Adapter-setup} - -- **参数** - - empty - -- **返回** - - - None - -### _async method_ `get_tenant_access_token(bot_config)` {#Adapter-get-tenant-access-token} - -- **参数** - - - `bot_config` ([BotConfig](config.md#BotConfig)) - -- **返回** - - - str - -### _classmethod_ `json_to_event(json_data)` {#Adapter-json-to-event} - -- **说明:** 将 json 数据转换为 Event 对象。 - -- **参数** - - - `json_data` (Any): json 数据 - - - `self_id`: 当前 Event 对应的 Bot - -- **返回** - - - [Event](event.md#Event) | None: Event 对象，如果解析失败则返回 None - -### _classmethod_ `add_custom_model(model)` {#Adapter-add-custom-model} - -- **说明:** 插入或覆盖一个自定义的 Event 类型。 需提供 `__event__` 属性，进行事件模型索引， 格式为 `{post_type}[.{sub_type}]`，如: `message.private`。 - -- **参数** - - - `model` (type[[Event](event.md#Event)]): 自定义的 Event 类型 - -- **返回** - - - None - -### _classmethod_ `get_event_model(event_name)` {#Adapter-get-event-model} - -- **说明:** 根据事件名获取对应 `Event Model` 及 `FallBack Event Model` 列表， 不包括基类 `Event`。 - -- **参数** - - - `event_name` (str) - -- **返回** - - - list[type[[Event](event.md#Event)]] - -### _classmethod_ `custom_send(send_func)` {#Adapter-custom-send} - -- **说明:** 自定义 Bot 的回复函数。 - -- **参数** - - - `send_func` (([Bot](bot.md#Bot), [Event](event.md#Event), str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)) -> Any) - -- **返回** - - - untyped diff --git a/website/versioned_docs/version-2.2.1/api/bot.md b/website/versioned_docs/version-2.2.1/api/bot.md deleted file mode 100644 index 4cecffc..0000000 --- a/website/versioned_docs/version-2.2.1/api/bot.md +++ /dev/null @@ -1,107 +0,0 @@ -# nonebot.adapters.feishu.bot - -## _async def_ `send(bot, event, message, at_sender=False, **kwargs)` {#send} - -- **说明:** 默认回复消息处理函数。 - -- **参数** - - - `bot` (Bot) - - - `event` ([Event](event.md#Event)) - - - `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)) - - - `at_sender` (bool) - - - `**kwargs` (Any) - -- **返回** - - - Any - -## _class_ `BotInfo()` {#BotInfo} - -- **参数** - - auto - -## _class_ `Bot(adapter, self_id, *, bot_config, bot_info)` {#Bot} - -- **参数** - - - `adapter` ([Adapter](adapter.md#Adapter)) - - - `self_id` (str) - - - `bot_config` ([BotConfig](config.md#BotConfig)) - - - `bot_info` (BotInfo) - -### _async method_ `send_handler(event, message, at_sender=False, **kwargs)` {#Bot-send-handler} - -- **说明:** 默认回复消息处理函数。 - -- **参数** - - - `event` ([Event](event.md#Event)) - - - `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)) - - - `at_sender` (bool) - - - `**kwargs` (Any) - -- **返回** - - - Any - -### _async method_ `send(event, message, **kwargs)` {#Bot-send} - -- **说明:** 根据 `event` 向触发事件的主体回复消息。 - -- **参数** - - - `event` ([Event](event.md#Event)): Event 对象 - - - `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)): 要发送的消息 - - - `at_sender` (bool): 是否 @ 事件主体 - - - `**kwargs` (Any): 其他参数，可以与 [Adapter.custom_send](adapter.md#Adapter-custom-send) 配合使用 - -- **返回** - - - Any: API 调用返回数据 - -- **异常** - - - ValueError: 缺少 `user_id`, `group_id` - - - NetworkError: 网络错误 - - - ActionFailed: API 调用失败 - -### _async method_ `call_api(api, **data)` {#Bot-call-api} - -- **说明:** :说明: 调用 飞书 协议 API :参数: _ `api: str`: API 名称 _ `**data: Any`: API 参数 :返回: - `Any`: API 调用返回数据 :异常: - `NetworkError`: 网络错误 - `ActionFailed`: API 调用失败 - -- **参数** - - - `api` (str) - - - `**data` - -- **返回** - - - Any - -### _async method_ `handle_event(event)` {#Bot-handle-event} - -- **参数** - - - `event` ([Event](event.md#Event)) - -- **返回** - - - None diff --git a/website/versioned_docs/version-2.2.1/api/config.md b/website/versioned_docs/version-2.2.1/api/config.md deleted file mode 100644 index 641535f..0000000 --- a/website/versioned_docs/version-2.2.1/api/config.md +++ /dev/null @@ -1,35 +0,0 @@ -# nonebot.adapters.feishu.config - -## _class_ `BotConfig()` {#BotConfig} - -- **说明** - - 飞书适配器机器人配置类 - - :配置项: - - - `app_id`: 飞书开放平台后台“凭证与基础信息”处给出的 App ID - - `app_secret`: 飞书开放平台后台“凭证与基础信息”处给出的 App Secret - - `encrypt_key`: 飞书开放平台后台“事件订阅”处设置的 Encrypt Key - - `verification_token`: 飞书开放平台后台“事件订阅”处设置的 Verification Token - - `is_lark`: 是否使用 Lark（飞书海外版），默认为 false - -- **参数** - - auto - -## _class_ `Config()` {#Config} - -- **说明** - - 飞书适配器全局配置类 - - :配置项: - - - `feishu_api_base`: 飞书国内版开放平台 API Endpoint - - `feishu_lark_api_base`: 飞书海外版（lark）开放平台 API Endpoint - - `feishu_bots`: 飞书适配器 Bot 配置列表，具体配置项参阅 BotConfig 类 - -- **参数** - - auto diff --git a/website/versioned_docs/version-2.2.1/api/event.md b/website/versioned_docs/version-2.2.1/api/event.md deleted file mode 100644 index 2c771da..0000000 --- a/website/versioned_docs/version-2.2.1/api/event.md +++ /dev/null @@ -1,540 +0,0 @@ -# nonebot.adapters.feishu.event - -## _class_ `Event()` {#Event} - -- **说明** - - 飞书协议事件。各事件字段参考 `飞书文档`\_ - - .. \_飞书文档: - https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list - -- **参数** - - auto - -### _method_ `get_type()` {#Event-get-type} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_event_name()` {#Event-get-event-name} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_event_description()` {#Event-get-event-description} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_message()` {#Event-get-message} - -- **参数** - - empty - -- **返回** - - - [Message](message.md#Message) - -### _method_ `get_plaintext()` {#Event-get-plaintext} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_user_id()` {#Event-get-user-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_session_id()` {#Event-get-session-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `is_tome()` {#Event-is-tome} - -- **参数** - - empty - -- **返回** - - - bool - -## _class_ `MessageEvent()` {#MessageEvent} - -- **参数** - - auto - -### _class-var_ `to_me` {#MessageEvent-to-me} - -- **类型:** bool - -- **说明** - - :说明: 消息是否与机器人有关 - - :类型: `bool` - -### _method_ `get_type()` {#MessageEvent-get-type} - -- **参数** - - empty - -- **返回** - - - Literal['message'] - -### _method_ `get_event_name()` {#MessageEvent-get-event-name} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_event_description()` {#MessageEvent-get-event-description} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_message()` {#MessageEvent-get-message} - -- **参数** - - empty - -- **返回** - - - [Message](message.md#Message) - -### _method_ `get_plaintext()` {#MessageEvent-get-plaintext} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_user_id()` {#MessageEvent-get-user-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_all_user_id()` {#MessageEvent-get-all-user-id} - -- **参数** - - empty - -- **返回** - - - UserId - -### _method_ `get_session_id()` {#MessageEvent-get-session-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `is_tome()` {#MessageEvent-is-tome} - -- **参数** - - empty - -- **返回** - - - bool - -## _class_ `GroupMessageEvent()` {#GroupMessageEvent} - -- **参数** - - auto - -## _class_ `PrivateMessageEvent()` {#PrivateMessageEvent} - -- **参数** - - auto - -## _class_ `NoticeEvent()` {#NoticeEvent} - -- **参数** - - auto - -### _method_ `get_type()` {#NoticeEvent-get-type} - -- **参数** - - empty - -- **返回** - - - Literal['notice'] - -### _method_ `get_event_name()` {#NoticeEvent-get-event-name} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_event_description()` {#NoticeEvent-get-event-description} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_message()` {#NoticeEvent-get-message} - -- **参数** - - empty - -- **返回** - - - [Message](message.md#Message) - -### _method_ `get_plaintext()` {#NoticeEvent-get-plaintext} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_user_id()` {#NoticeEvent-get-user-id} - -- **参数** - - empty - -- **返回** - - - str - -### _method_ `get_session_id()` {#NoticeEvent-get-session-id} - -- **参数** - - empty - -- **返回** - - - str - -## _class_ `MessageReadEvent()` {#MessageReadEvent} - -- **参数** - - auto - -## _class_ `GroupDisbandedEvent()` {#GroupDisbandedEvent} - -- **参数** - - auto - -## _class_ `MessageReactionDeletedEvent()` {#MessageReactionDeletedEvent} - -- **参数** - - auto - -## _class_ `MessageReactionCreatedEvent()` {#MessageReactionCreatedEvent} - -- **参数** - - auto - -## _class_ `GroupConfigUpdatedEvent()` {#GroupConfigUpdatedEvent} - -- **参数** - - auto - -## _class_ `GroupMemberBotAddedEvent()` {#GroupMemberBotAddedEvent} - -- **参数** - - auto - -## _class_ `GroupMemberBotDeletedEvent()` {#GroupMemberBotDeletedEvent} - -- **参数** - - auto - -## _class_ `GroupMemberUserAddedEvent()` {#GroupMemberUserAddedEvent} - -- **参数** - - auto - -## _class_ `GroupMemberUserWithdrawnEvent()` {#GroupMemberUserWithdrawnEvent} - -- **参数** - - auto - -## _class_ `GroupMemberUserDeletedEvent()` {#GroupMemberUserDeletedEvent} - -- **参数** - - auto - -## _class_ `ContactUserUpdatedEvent()` {#ContactUserUpdatedEvent} - -- **参数** - - auto - -## _class_ `ContactUserDeletedEvent()` {#ContactUserDeletedEvent} - -- **参数** - - auto - -## _class_ `ContactUserCreatedEvent()` {#ContactUserCreatedEvent} - -- **参数** - - auto - -## _class_ `ContactDepartmentUpdatedEvent()` {#ContactDepartmentUpdatedEvent} - -- **参数** - - auto - -## _class_ `ContactDepartmentDeletedEvent()` {#ContactDepartmentDeletedEvent} - -- **参数** - - auto - -## _class_ `ContactDepartmentCreatedEvent()` {#ContactDepartmentCreatedEvent} - -- **参数** - - auto - -## _class_ `CalendarAclCreatedEvent()` {#CalendarAclCreatedEvent} - -- **参数** - - auto - -## _class_ `CalendarAclDeletedEvent()` {#CalendarAclDeletedEvent} - -- **参数** - - auto - -## _class_ `CalendarChangedEvent()` {#CalendarChangedEvent} - -- **参数** - - auto - -## _class_ `CalendarEventChangedEvent()` {#CalendarEventChangedEvent} - -- **参数** - - auto - -## _class_ `DriveFileReadEvent()` {#DriveFileReadEvent} - -- **参数** - - auto - -## _class_ `DriveFileTitleUpdatedEvent()` {#DriveFileTitleUpdatedEvent} - -- **参数** - - auto - -## _class_ `DriveFilePermissionMemberAddedEvent()` {#DriveFilePermissionMemberAddedEvent} - -- **参数** - - auto - -## _class_ `DriveFilePermissionMemberRemovedEvent()` {#DriveFilePermissionMemberRemovedEvent} - -- **参数** - - auto - -## _class_ `DriveFileTrashedEvent()` {#DriveFileTrashedEvent} - -- **参数** - - auto - -## _class_ `DriveFileDeletedEvent()` {#DriveFileDeletedEvent} - -- **参数** - - auto - -## _class_ `DriveFileEditedEvent()` {#DriveFileEditedEvent} - -- **参数** - - auto - -## _class_ `MeetingRoomCreatedEvent()` {#MeetingRoomCreatedEvent} - -- **参数** - - auto - -## _class_ `MeetingRoomUpdatedEvent()` {#MeetingRoomUpdatedEvent} - -- **参数** - - auto - -## _class_ `MeetingRoomDeletedEvent()` {#MeetingRoomDeletedEvent} - -- **参数** - - auto - -## _class_ `MeetingRoomStatusChangedEvent()` {#MeetingRoomStatusChangedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingStartedEvent()` {#VCMeetingStartedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingEndedEvent()` {#VCMeetingEndedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingJoinedEvent()` {#VCMeetingJoinedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingLeftEvent()` {#VCMeetingLeftEvent} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingStartedEvent()` {#VCMeetingRecordingStartedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingEndedEvent()` {#VCMeetingRecordingEndedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingReadyEvent()` {#VCMeetingRecordingReadyEvent} - -- **参数** - - auto - -## _class_ `VCMeetingShareStartedEvent()` {#VCMeetingShareStartedEvent} - -- **参数** - - auto - -## _class_ `VCMeetingShareEndedEvent()` {#VCMeetingShareEndedEvent} - -- **参数** - - auto - -## _class_ `AttendanceUserFlowCreatedEvent()` {#AttendanceUserFlowCreatedEvent} - -- **参数** - - auto - -## _class_ `AttendanceUserTaskUpdatedEvent()` {#AttendanceUserTaskUpdatedEvent} - -- **参数** - - auto diff --git a/website/versioned_docs/version-2.2.1/api/exception.md b/website/versioned_docs/version-2.2.1/api/exception.md deleted file mode 100644 index 9e5a234..0000000 --- a/website/versioned_docs/version-2.2.1/api/exception.md +++ /dev/null @@ -1,45 +0,0 @@ -# nonebot.adapters.feishu.exception - -## _class_ `FeishuAdapterException()` {#FeishuAdapterException} - -- **参数** - - auto - -## _class_ `ActionFailed()` {#ActionFailed} - -- **说明** - - :说明: - - API 请求返回错误信息。 - - :参数: - - - `retcode: Optional[int]`: 错误码 - -- **参数** - - auto - -## _class_ `NetworkError()` {#NetworkError} - -- **说明** - - :说明: - - 网络错误。 - - :参数: - - - `retcode: Optional[int]`: 错误码 - -- **参数** - - auto - -## _class_ `ApiNotAvailable()` {#ApiNotAvailable} - -- **参数** - - auto diff --git a/website/versioned_docs/version-2.2.1/api/index.md b/website/versioned_docs/version-2.2.1/api/index.md deleted file mode 100644 index 6e59ec0..0000000 --- a/website/versioned_docs/version-2.2.1/api/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# nonebot.adapters.feishu - -飞书协议适配 diff --git a/website/versioned_docs/version-2.2.1/api/message.md b/website/versioned_docs/version-2.2.1/api/message.md deleted file mode 100644 index 79b893d..0000000 --- a/website/versioned_docs/version-2.2.1/api/message.md +++ /dev/null @@ -1,543 +0,0 @@ -# nonebot.adapters.feishu.message - -## _class_ `MessageSegment()` {#MessageSegment} - -- **说明:** 飞书 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。 - -- **参数** - - auto - -### _classmethod_ `get_message_class()` {#MessageSegment-get-message-class} - -- **参数** - - empty - -- **返回** - - - type[Message] - -### _method_ `is_text()` {#MessageSegment-is-text} - -- **参数** - - empty - -- **返回** - - - bool - -### _staticmethod_ `text(text)` {#MessageSegment-text} - -- **参数** - - - `text` (str) - -- **返回** - - - Text - -### _staticmethod_ `post(title, content, language="zh_cn")` {#MessageSegment-post} - -- **参数** - - - `title` (str) - - - `content` (list[list[PostMessageNode]]) - - - `language` (str) - -- **返回** - - - Post - -### _staticmethod_ `image(image_key)` {#MessageSegment-image} - -- **参数** - - - `image_key` (str) - -- **返回** - - - Image - -### _staticmethod_ `interactive(header, config, elements=None, i18n_elements=None)` {#MessageSegment-interactive} - -- **参数** - - - `header` (InteractiveHeader) - - - `config` (InteractiveConfig) - - - `elements` (list[dict[str, Any]] | None) - - - `i18n_elements` (list[dict[str, Any]] | None) - -- **返回** - - - untyped - -### _staticmethod_ `interactive_template(template_id, template_variable)` {#MessageSegment-interactive-template} - -- **参数** - - - `template_id` (str) - - - `template_variable` (dict[str, Any]) - -- **返回** - - - InteractiveTemplate - -### _staticmethod_ `todo(task_id, summary, due_time)` {#MessageSegment-todo} - -- **参数** - - - `task_id` (str) - - - `summary` (\_PostData) - - - `due_time` (str) - -- **返回** - - - untyped - -### _staticmethod_ `hongbao(text)` {#MessageSegment-hongbao} - -- **参数** - - - `text` (str) - -- **返回** - - - Hongbao - -### _staticmethod_ `system(template, from_user, to_chatters)` {#MessageSegment-system} - -- **参数** - - - `template` (str) - - - `from_user` (list[str]) - - - `to_chatters` (list[str]) - -- **返回** - - - System - -### _staticmethod_ `location(name, longitude, latitude)` {#MessageSegment-location} - -- **参数** - - - `name` (str) - - - `longitude` (str) - - - `latitude` (str) - -- **返回** - - - Location - -### _staticmethod_ `video_chat(topic, start_time)` {#MessageSegment-video-chat} - -- **参数** - - - `topic` (str) - - - `start_time` (str) - -- **返回** - - - untyped - -### _staticmethod_ `share_chat(chat_id)` {#MessageSegment-share-chat} - -- **参数** - - - `chat_id` (str) - -- **返回** - - - MessageSegment - -### _staticmethod_ `share_user(user_id)` {#MessageSegment-share-user} - -- **参数** - - - `user_id` (str) - -- **返回** - - - MessageSegment - -### _staticmethod_ `audio(file_key, duration=None)` {#MessageSegment-audio} - -- **参数** - - - `file_key` (str) - - - `duration` (int | None) - -- **返回** - - - MessageSegment - -### _staticmethod_ `media(file_key, image_key=None, file_name=None, duration=None)` {#MessageSegment-media} - -- **参数** - - - `file_key` (str) - - - `image_key` (str | None) - - - `file_name` (str | None) - - - `duration` (int | None) - -- **返回** - - - MessageSegment - -### _staticmethod_ `file(file_key, file_name=None)` {#MessageSegment-file} - -- **参数** - - - `file_key` (str) - - - `file_name` (str | None) - -- **返回** - - - MessageSegment - -### _staticmethod_ `folder(file_key, file_name)` {#MessageSegment-folder} - -- **参数** - - - `file_key` (str) - - - `file_name` (str) - -- **返回** - - - MessageSegment - -### _staticmethod_ `sticker(file_key)` {#MessageSegment-sticker} - -- **参数** - - - `file_key` (str) - -- **返回** - - - MessageSegment - -### _method_ `to_post()` {#MessageSegment-to-post} - -- **参数** - - empty - -- **返回** - - - untyped - -## _class_ `Text()` {#Text} - -- **说明:** Text(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `At()` {#At} - -- **说明:** At(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `AtAll()` {#AtAll} - -- **说明:** AtAll(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Image()` {#Image} - -- **说明:** Image(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `InteractiveHeaderTitle()` {#InteractiveHeaderTitle} - -- **参数** - - auto - -## _class_ `InteractiveHeader()` {#InteractiveHeader} - -- **参数** - - auto - -## _class_ `InteractiveConfig()` {#InteractiveConfig} - -- **参数** - - auto - -## _class_ `Interactive()` {#Interactive} - -- **参数** - - auto - -## _class_ `InteractiveTemplate()` {#InteractiveTemplate} - -- **说明:** InteractiveTemplate(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `ShareChat()` {#ShareChat} - -- **说明:** ShareChat(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `ShareUser()` {#ShareUser} - -- **说明:** ShareUser(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Audio()` {#Audio} - -- **说明:** Audio(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Media()` {#Media} - -- **说明:** Media(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `File()` {#File} - -- **说明:** File(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Folder()` {#Folder} - -- **说明:** Folder(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Sticker()` {#Sticker} - -- **说明:** Sticker(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `PostMessageNode()` {#PostMessageNode} - -- **参数** - - auto - -## _class_ `PostMessageNodeStylable()` {#PostMessageNodeStylable} - -- **参数** - - auto - -## _class_ `PostText()` {#PostText} - -- **参数** - - auto - -## _class_ `PostA()` {#PostA} - -- **参数** - - auto - -## _class_ `PostAt()` {#PostAt} - -- **参数** - - auto - -## _class_ `PostImg()` {#PostImg} - -- **参数** - - auto - -## _class_ `PostMedia()` {#PostMedia} - -- **参数** - - auto - -## _class_ `PostEmotion()` {#PostEmotion} - -- **参数** - - auto - -## _class_ `Post()` {#Post} - -- **说明:** Post(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `System()` {#System} - -- **说明:** System(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Location()` {#Location} - -- **说明:** Location(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `VideoChat()` {#VideoChat} - -- **说明:** VideoChat(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Todo()` {#Todo} - -- **说明:** Todo(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Vote()` {#Vote} - -- **说明:** Vote(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Hongbao()` {#Hongbao} - -- **说明:** Hongbao(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `ShareCalendarEvent()` {#ShareCalendarEvent} - -- **说明:** ShareCalendarEvent(type: str, data: Dict[str, Any] = ) - -- **参数** - - auto - -## _class_ `Calendar()` {#Calendar} - -- **参数** - - auto - -## _class_ `GeneralCalendar()` {#GeneralCalendar} - -- **参数** - - auto - -## _class_ `Message()` {#Message} - -- **说明:** 飞书 协议 Message 适配。 - -- **参数** - - auto - -### _classmethod_ `get_segment_class()` {#Message-get-segment-class} - -- **参数** - - empty - -- **返回** - - - type[MessageSegment] - -### _method_ `serialize()` {#Message-serialize} - -- **参数** - - empty - -- **返回** - - - tuple[str, str] - -### _staticmethod_ `deserialize(content, mentions, message_type)` {#Message-deserialize} - -- **参数** - - - `content` (str) - - - `mentions` (list[Mention] | None) - - - `message_type` (str) - -- **返回** - - - Message - -### _method_ `extract_plain_text()` {#Message-extract-plain-text} - -- **参数** - - empty - -- **返回** - - - str diff --git a/website/versioned_docs/version-2.2.1/api/models/common.md b/website/versioned_docs/version-2.2.1/api/models/common.md deleted file mode 100644 index 014f8a0..0000000 --- a/website/versioned_docs/version-2.2.1/api/models/common.md +++ /dev/null @@ -1,457 +0,0 @@ -# nonebot.adapters.feishu.models.common - -## _class_ `EventHeader()` {#EventHeader} - -- **参数** - - auto - -## _class_ `UserId()` {#UserId} - -- **参数** - - auto - -## _class_ `MeetingUser()` {#MeetingUser} - -- **参数** - - auto - -## _class_ `Meeting()` {#Meeting} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingReadyEventDetail()` {#VCMeetingRecordingReadyEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingEndedEventDetail()` {#VCMeetingRecordingEndedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingRecordingStartedEventDetail()` {#VCMeetingRecordingStartedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingLeftEventDetail()` {#VCMeetingLeftEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingJoinedEventDetail()` {#VCMeetingJoinedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingEndedEventDetail()` {#VCMeetingEndedEventDetail} - -- **参数** - - auto - -## _class_ `Sender()` {#Sender} - -- **参数** - - auto - -## _class_ `ReplySender()` {#ReplySender} - -- **参数** - - auto - -## _class_ `Mention()` {#Mention} - -- **参数** - - auto - -## _class_ `ReplyMention()` {#ReplyMention} - -- **参数** - - auto - -## _class_ `MessageBody()` {#MessageBody} - -- **参数** - - auto - -## _class_ `Reply()` {#Reply} - -- **参数** - - auto - -## _class_ `EventMessage()` {#EventMessage} - -- **参数** - - auto - -## _class_ `GroupEventMessage()` {#GroupEventMessage} - -- **参数** - - auto - -## _class_ `PrivateEventMessage()` {#PrivateEventMessage} - -- **参数** - - auto - -## _class_ `MessageEventDetail()` {#MessageEventDetail} - -- **参数** - - auto - -## _class_ `GroupMessageEventDetail()` {#GroupMessageEventDetail} - -- **参数** - - auto - -## _class_ `PrivateMessageEventDetail()` {#PrivateMessageEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingShareStartedEventDetail()` {#VCMeetingShareStartedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingShareEndedEventDetail()` {#VCMeetingShareEndedEventDetail} - -- **参数** - - auto - -## _class_ `AttendanceUserFlowCreatedEventDetail()` {#AttendanceUserFlowCreatedEventDetail} - -- **参数** - - auto - -## _class_ `AttendanceUserTaskStatusDiff()` {#AttendanceUserTaskStatusDiff} - -- **参数** - - auto - -## _class_ `AttendanceUserTaskUpdatedEventDetail()` {#AttendanceUserTaskUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `VCMeetingStartedEventDetail()` {#VCMeetingStartedEventDetail} - -- **参数** - - auto - -## _class_ `MeetingRoomStatusChangedEventDetail()` {#MeetingRoomStatusChangedEventDetail} - -- **参数** - - auto - -## _class_ `MeetingRoomDeletedEventDetail()` {#MeetingRoomDeletedEventDetail} - -- **参数** - - auto - -## _class_ `MeetingRoomUpdatedEventDetail()` {#MeetingRoomUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `MeetingRoomCreatedEventDetail()` {#MeetingRoomCreatedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileEditedEventDetail()` {#DriveFileEditedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileDeletedEventDetail()` {#DriveFileDeletedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileTrashedEventDetail()` {#DriveFileTrashedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFilePermissionMemberRemovedEventDetail()` {#DriveFilePermissionMemberRemovedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFilePermissionMemberAddedEventDetail()` {#DriveFilePermissionMemberAddedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileTitleUpdatedEventDetail()` {#DriveFileTitleUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `DriveFileReadEventDetail()` {#DriveFileReadEventDetail} - -- **参数** - - auto - -## _class_ `CalendarEventChangedEventDetail()` {#CalendarEventChangedEventDetail} - -- **参数** - - auto - -## _class_ `CalendarAclScope()` {#CalendarAclScope} - -- **参数** - - auto - -## _class_ `CalendarAclDeletedEventDetail()` {#CalendarAclDeletedEventDetail} - -- **参数** - - auto - -## _class_ `CalendarAclCreatedEventDetail()` {#CalendarAclCreatedEventDetail} - -- **参数** - - auto - -## _class_ `ContactDepartmentStatus()` {#ContactDepartmentStatus} - -- **参数** - - auto - -## _class_ `ContactDepartment()` {#ContactDepartment} - -- **参数** - - auto - -## _class_ `ContactDepartmentCreatedEventDetail()` {#ContactDepartmentCreatedEventDetail} - -- **参数** - - auto - -## _class_ `OldContactDepartment()` {#OldContactDepartment} - -- **参数** - - auto - -## _class_ `ContactDepartmentDeletedEventDetail()` {#ContactDepartmentDeletedEventDetail} - -- **参数** - - auto - -## _class_ `ContactDepartmentUpdatedEventDetail()` {#ContactDepartmentUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `AvatarInfo()` {#AvatarInfo} - -- **参数** - - auto - -## _class_ `UserStatus()` {#UserStatus} - -- **参数** - - auto - -## _class_ `UserOrder()` {#UserOrder} - -- **参数** - - auto - -## _class_ `UserCustomAttrValue()` {#UserCustomAttrValue} - -- **参数** - - auto - -## _class_ `UserCustomAttr()` {#UserCustomAttr} - -- **参数** - - auto - -## _class_ `ContactUser()` {#ContactUser} - -- **参数** - - auto - -## _class_ `OldContactUser()` {#OldContactUser} - -- **参数** - - auto - -## _class_ `ContactUserCreatedEventDetail()` {#ContactUserCreatedEventDetail} - -- **参数** - - auto - -## _class_ `ContactUserDeletedEventDetail()` {#ContactUserDeletedEventDetail} - -- **参数** - - auto - -## _class_ `ContactUserUpdatedEventDetail()` {#ContactUserUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `ChatMemberUser()` {#ChatMemberUser} - -- **参数** - - auto - -## _class_ `GroupMemberUserDeletedEventDetail()` {#GroupMemberUserDeletedEventDetail} - -- **参数** - - auto - -## _class_ `GroupMemberUserWithdrawnEventDetail()` {#GroupMemberUserWithdrawnEventDetail} - -- **参数** - - auto - -## _class_ `GroupMemberUserAddedEventDetail()` {#GroupMemberUserAddedEventDetail} - -- **参数** - - auto - -## _class_ `GroupMemberBotDeletedEventDetail()` {#GroupMemberBotDeletedEventDetail} - -- **参数** - - auto - -## _class_ `GroupMemberBotAddedEventDetail()` {#GroupMemberBotAddedEventDetail} - -- **参数** - - auto - -## _class_ `I18nNames()` {#I18nNames} - -- **参数** - - auto - -## _class_ `Emoji()` {#Emoji} - -- **参数** - - auto - -## _class_ `ChatChange()` {#ChatChange} - -- **参数** - - auto - -## _class_ `EventModerator()` {#EventModerator} - -- **参数** - - auto - -## _class_ `ModeratorList()` {#ModeratorList} - -- **参数** - - auto - -## _class_ `GroupConfigUpdatedEventDetail()` {#GroupConfigUpdatedEventDetail} - -- **参数** - - auto - -## _class_ `MessageReactionCreatedEventDetail()` {#MessageReactionCreatedEventDetail} - -- **参数** - - auto - -## _class_ `MessageReactionDeletedEventDetail()` {#MessageReactionDeletedEventDetail} - -- **参数** - - auto - -## _class_ `GroupDisbandedEventDetail()` {#GroupDisbandedEventDetail} - -- **参数** - - auto - -## _class_ `MessageReader()` {#MessageReader} - -- **参数** - - auto - -## _class_ `MessageReadEventDetail()` {#MessageReadEventDetail} - -- **参数** - - auto diff --git a/website/versioned_docs/version-2.2.1/api/models/index.md b/website/versioned_docs/version-2.2.1/api/models/index.md deleted file mode 100644 index 5905810..0000000 --- a/website/versioned_docs/version-2.2.1/api/models/index.md +++ /dev/null @@ -1 +0,0 @@ -# nonebot.adapters.feishu.models diff --git a/website/versioned_docs/version-2.2.1/api/utils.md b/website/versioned_docs/version-2.2.1/api/utils.md deleted file mode 100644 index 118ec48..0000000 --- a/website/versioned_docs/version-2.2.1/api/utils.md +++ /dev/null @@ -1,47 +0,0 @@ -# nonebot.adapters.feishu.utils - -## _def_ `log()` {#log} - -- **参数** - - auto - -- **返回** - - - untyped - -## _class_ `AESCipher(key)` {#AESCipher} - -- **参数** - - - `key` - -### _staticmethod_ `str_to_bytes(data)` {#AESCipher-str-to-bytes} - -- **参数** - - - `data` - -- **返回** - - - untyped - -### _method_ `decrypt(enc)` {#AESCipher-decrypt} - -- **参数** - - - `enc` - -- **返回** - - - untyped - -### _method_ `decrypt_string(enc)` {#AESCipher-decrypt-string} - -- **参数** - - - `enc` - -- **返回** - - - untyped diff --git a/website/versioned_docs/version-2.2.1/guide/README.md b/website/versioned_docs/version-2.2.1/guide/README.md deleted file mode 100644 index 5e1c0d7..0000000 --- a/website/versioned_docs/version-2.2.1/guide/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 0 -id: index -description: 飞书适配器概览 - -slug: /guide/ ---- - -# 概览 diff --git a/website/versioned_docs/version-2.2.1/guide/installation.md b/website/versioned_docs/version-2.2.1/guide/installation.md deleted file mode 100644 index 860b0b6..0000000 --- a/website/versioned_docs/version-2.2.1/guide/installation.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -sidebar_position: 1 -description: 安装 - -options: - menu: - - category: guide - weight: 20 ---- - -# 安装飞书适配器 - -```bash -pip install nonebot-adapter-feishu -``` - -## 注册飞书适配器 - -在 `bot.py` 中添加： - -```python title=bot.py {2,7} -import nonebot -from nonebot.adapters.feishu import Adapter as FeishuAdapter - -nonebot.init() - -driver = nonebot.get_driver() -driver.register_adapter(FeishuAdapter) -``` diff --git a/website/versioned_docs/version-2.2.1/guide/setup.md b/website/versioned_docs/version-2.2.1/guide/setup.md deleted file mode 100644 index 8480fa1..0000000 --- a/website/versioned_docs/version-2.2.1/guide/setup.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -sidebar_position: 2 -description: 配置连接 - -options: - menu: - - category: guide - weight: 30 ---- - -# 配置连接 - -## 创建应用与启用应用“机器人”能力 - -:::tip 提示 -此部分可参考[飞书开放平台-快速开发机器人-创建应用](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)部分的文档。 - -::: - -## 在 NoneBot 配置文件中添加相应配置 - -复制所创建应用**“凭证和基础信息”**中的 **App ID** 、 **App Secret** 和 **“事件订阅”** 中的 **Verification Token** ，替换以下配置模板中的值。 - -如果在飞书开发者后台的事件订阅中配置了事件上报的 Encrypt Key，也需要传入 FEISHU_BOTS 中。 - -当 `encrypt_key` 存在且不为空时，飞书适配器会认为用户启用了加密机制，并对事件上报中的密文进行解密。 - -如果不需要启用加密功能，请将配置项中的 `encrypt_key` 键值对删去，或将 `encrypt_key` 置为 `null`。 - -对于[Lark(飞书平台海外版)](https://www.larksuite.com) 的用户，飞书适配器也提供**实验性**支持，仅需要在配置文件中将 `is_lark` 改为 `true`。 - -```bash -FEISHU_BOTS=' -[ - { - "app_id": "", - "app_secret": "", - "verification_token": "", - "encrypt_key": "", - "is_lark": false - } -] -' -``` - -飞书适配器支持同时传入多份配置，仅需要按相同格式传入 `FEISHU_BOTS` 即可。 - -```bash -FEISHU_BOTS=' -[ - { - "app_id": "", - "app_secret": "", - "verification_token": "", - "encrypt_key": "", - "is_lark": false - }, - { - "app_id": "", - "app_secret": "", - "verification_token": "", - "encrypt_key": "", - "is_lark": false - } -] -``` - -## 开启应用权限 - -应用拥有所需权限后，才能调用飞书接口获取相关信息。如果需要用到所有飞书平台的 API，请开启所有应用权限。 - -在仅群聊功能的情况下，需要为应用开启用户、消息、通讯录和群聊权限组所有权限，并且启用机器人角色以便获取机器人昵称。 - -## 配置飞书事件订阅 - -### 配置上报地址 - -飞书适配器会自动注册以下地址作为事件订阅上报入口点。 - -由于飞书开放平台的事件订阅并不会上报 App ID，在填写事件订阅请求网址时，请按照如下格式填写，对应的以 `$` 开头的变量请使用 `.env.*` 文件中所定义的值进行替换，`$app_id` 替换为飞书开放平台提供的 App ID。 - -```bash -http://$HOST:$PORT/feishu/$app_id -``` - -### 配置事件订阅列表 - -:::tip 提示 - -在添加事件订阅时请注意，带有**（历史版本）**字样的事件的格式为**不受支持的旧版事件格式**，请使用对应的**新版事件（不带历史版本字样）作为替代**。 - -::: - -## 编写一个适用于飞书适配器的插件并加载 - -插件代码范例： - -```python -from nonebot.plugin import on_command -from nonebot.typing import T_State -from nonebot.adapters.feishu import Bot as FeishuBot, MessageEvent - -helper = on_command("say") - - -@helper.handle() -async def feishu_helper( - bot: FeishuBot, - event: MessageEvent, - state: T_State, - command_arg: Message = CommandArg(), -): - await helper.finish(command_arg, at_sender=True) -``` - -以上代码注册了一个对飞书平台适用的 `say` 指令，并会提取 `/say` 之后的内容发送到事件所对应的群或私聊。 - -大功告成！现在可以试试向机器人发送类似 `/say Hello, Feishu!` 的消息进行测试了。 diff --git a/website/versioned_sidebars/version-2.2.0-sidebars.json b/website/versioned_sidebars/version-2.2.0-sidebars.json deleted file mode 100644 index cb60e72..0000000 --- a/website/versioned_sidebars/version-2.2.0-sidebars.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "guide": [ - { - "type": "autogenerated", - "dirName": "guide" - } - ], - "api": [ - { - "type": "autogenerated", - "dirName": "api" - } - ] -} diff --git a/website/versioned_sidebars/version-2.2.1-sidebars.json b/website/versioned_sidebars/version-2.2.1-sidebars.json deleted file mode 100644 index cb60e72..0000000 --- a/website/versioned_sidebars/version-2.2.1-sidebars.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "guide": [ - { - "type": "autogenerated", - "dirName": "guide" - } - ], - "api": [ - { - "type": "autogenerated", - "dirName": "api" - } - ] -} diff --git a/website/versions.json b/website/versions.json index 75eea0a..5ec4b01 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1 +1 @@ -["2.3.0", "2.2.1", "2.2.0"] +["2.3.0"]