mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2026-09-11 03:05:59 +00:00
Update documentation
This commit is contained in:
Lonami
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ApplyGiftCodeRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="apply_gift_code.html">ApplyGiftCodeRequest</a></li></ul><h1>ApplyGiftCodeRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.applyGiftCode#f6e26854 slug:<a href="../../index.html#string">string</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.payments import ApplyGiftCodeRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>slug</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ApplyGiftCodeRequest(
|
||||
slug=<em>'some string here'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,29 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>AssignAppStoreTransactionRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="assign_app_store_transaction.html">AssignAppStoreTransactionRequest</a></li></ul><h1>AssignAppStoreTransactionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.assignAppStoreTransaction#80ed747d receipt:<a href="../../index.html#bytes">bytes</a> purpose:<a href="../../types/input_store_payment_purpose.html">InputStorePaymentPurpose</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.payments import AssignAppStoreTransactionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>receipt</b></td><td style="text-align:center"><a href="../../index.html#bytes">bytes</a></td><td></td></tr><tr><td><b>purpose</b></td><td style="text-align:center"><a href="../../types/input_store_payment_purpose.html">InputStorePaymentPurpose</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.AssignAppStoreTransactionRequest(
|
||||
receipt=<em>b'arbitrary\x7f data \xfa here'</em>,
|
||||
purpose=types.InputStorePaymentPremiumSubscription(
|
||||
restore=<strong>True</strong>,
|
||||
upgrade=<strong>True</strong>
|
||||
)
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,31 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>AssignPlayMarketTransactionRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="assign_play_market_transaction.html">AssignPlayMarketTransactionRequest</a></li></ul><h1>AssignPlayMarketTransactionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.assignPlayMarketTransaction#dffd50d3 receipt:<a href="../../types/data_json.html">DataJSON</a> purpose:<a href="../../types/input_store_payment_purpose.html">InputStorePaymentPurpose</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.payments import AssignPlayMarketTransactionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>receipt</b></td><td style="text-align:center"><a href="../../types/data_json.html">DataJSON</a></td><td></td></tr><tr><td><b>purpose</b></td><td style="text-align:center"><a href="../../types/input_store_payment_purpose.html">InputStorePaymentPurpose</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.AssignPlayMarketTransactionRequest(
|
||||
receipt=types.DataJSON(
|
||||
data=<em>'some string here'</em>
|
||||
),
|
||||
purpose=types.InputStorePaymentPremiumSubscription(
|
||||
restore=<strong>True</strong>,
|
||||
upgrade=<strong>True</strong>
|
||||
)
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,27 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>BotCancelStarsSubscriptionRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="bot_cancel_stars_subscription.html">BotCancelStarsSubscriptionRequest</a></li></ul><h1>BotCancelStarsSubscriptionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.botCancelStarsSubscription#6dfa0622 flags:# restore:flags.0?<a href="../../index.html#true">true</a> user_id:<a href="../../types/input_user.html">InputUser</a> charge_id:<a href="../../index.html#string">string</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import BotCancelStarsSubscriptionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>user_id</b></td><td style="text-align:center"><a href="../../types/input_user.html">InputUser</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>charge_id</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>restore</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.BotCancelStarsSubscriptionRequest(
|
||||
user_id=<em>'username'</em>,
|
||||
charge_id=<em>'some string here'</em>,
|
||||
restore=<strong>True</strong>
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,28 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>CanPurchaseStoreRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="can_purchase_store.html">CanPurchaseStoreRequest</a></li></ul><h1>CanPurchaseStoreRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.canPurchaseStore#4fdc5ea7 purpose:<a href="../../types/input_store_payment_purpose.html">InputStorePaymentPurpose</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import CanPurchaseStoreRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>purpose</b></td><td style="text-align:center"><a href="../../types/input_store_payment_purpose.html">InputStorePaymentPurpose</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.CanPurchaseStoreRequest(
|
||||
purpose=types.InputStorePaymentPremiumSubscription(
|
||||
restore=<strong>True</strong>,
|
||||
upgrade=<strong>True</strong>
|
||||
)
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,27 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ChangeStarsSubscriptionRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="change_stars_subscription.html">ChangeStarsSubscriptionRequest</a></li></ul><h1>ChangeStarsSubscriptionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.changeStarsSubscription#c7770878 flags:# peer:<a href="../../types/input_peer.html">InputPeer</a> subscription_id:<a href="../../index.html#string">string</a> canceled:flags.0?<a href="../../index.html#bool">Bool</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import ChangeStarsSubscriptionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>subscription_id</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>canceled</b></td><td style="text-align:center"><a href="../../index.html#bool">Bool</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ChangeStarsSubscriptionRequest(
|
||||
peer=<em>'username'</em>,
|
||||
subscription_id=<em>'some string here'</em>,
|
||||
canceled=<strong>False</strong>
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>CheckCanSendGiftRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="check_can_send_gift.html">CheckCanSendGiftRequest</a></li></ul><h1>CheckCanSendGiftRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.checkCanSendGift#c0c4edc9 gift_id:<a href="../../index.html#long">long</a> = <a href="../../types/payments/check_can_send_gift_result.html">payments.CheckCanSendGiftResult</a></pre><button onclick="cp('from telethon.tl.functions.payments import CheckCanSendGiftRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/check_can_send_gift_result.html">payments.CheckCanSendGiftResult</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/check_can_send_gift_result_fail.html">CheckCanSendGiftResultFail</a></td><td><a href="../../constructors/payments/check_can_send_gift_result_ok.html">CheckCanSendGiftResultOk</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>gift_id</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.CheckCanSendGiftRequest(
|
||||
gift_id=-12398745604826
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>CheckGiftCodeRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="check_gift_code.html">CheckGiftCodeRequest</a></li></ul><h1>CheckGiftCodeRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.checkGiftCode#8e51b4c1 slug:<a href="../../index.html#string">string</a> = <a href="../../types/payments/checked_gift_code.html">payments.CheckedGiftCode</a></pre><button onclick="cp('from telethon.tl.functions.payments import CheckGiftCodeRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/checked_gift_code.html">payments.CheckedGiftCode</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/checked_gift_code.html">CheckedGiftCode</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>slug</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.CheckGiftCodeRequest(
|
||||
slug=<em>'some string here'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ClearSavedInfoRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="clear_saved_info.html">ClearSavedInfoRequest</a></li></ul><h1>ClearSavedInfoRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.clearSavedInfo#d83d70c1 flags:# credentials:flags.0?<a href="../../index.html#true">true</a> info:flags.1?<a href="../../index.html#true">true</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import ClearSavedInfoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>credentials</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>info</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ClearSavedInfoRequest(
|
||||
credentials=<strong>True</strong>,
|
||||
info=<strong>True</strong>
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ConnectStarRefBotRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="connect_star_ref_bot.html">ConnectStarRefBotRequest</a></li></ul><h1>ConnectStarRefBotRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.connectStarRefBot#7ed5348a peer:<a href="../../types/input_peer.html">InputPeer</a> bot:<a href="../../types/input_user.html">InputUser</a> = <a href="../../types/payments/connected_star_ref_bots.html">payments.ConnectedStarRefBots</a></pre><button onclick="cp('from telethon.tl.functions.payments import ConnectStarRefBotRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/connected_star_ref_bots.html">payments.ConnectedStarRefBots</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/connected_star_ref_bots.html">ConnectedStarRefBots</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>bot</b></td><td style="text-align:center"><a href="../../types/input_user.html">InputUser</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ConnectStarRefBotRequest(
|
||||
peer=<em>'username'</em>,
|
||||
bot=<em>'username'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,27 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ConvertStarGiftRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="convert_star_gift.html">ConvertStarGiftRequest</a></li></ul><h1>ConvertStarGiftRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.convertStarGift#74bf076b stargift:<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import ConvertStarGiftRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ConvertStarGiftRequest(
|
||||
stargift=types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
)
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,29 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>CreateStarGiftCollectionRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="create_star_gift_collection.html">CreateStarGiftCollectionRequest</a></li></ul><h1>CreateStarGiftCollectionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.createStarGiftCollection#1f4a0e87 peer:<a href="../../types/input_peer.html">InputPeer</a> title:<a href="../../index.html#string">string</a> stargift:<a href="../../index.html#vector">Vector</a><<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a>> = <a href="../../types/star_gift_collection.html">StarGiftCollection</a></pre><button onclick="cp('from telethon.tl.functions.payments import CreateStarGiftCollectionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/star_gift_collection.html">StarGiftCollection</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/star_gift_collection.html">StarGiftCollection</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>title</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td>A <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.CreateStarGiftCollectionRequest(
|
||||
peer=<em>'username'</em>,
|
||||
title=<em>'My awesome title'</em>,
|
||||
stargift=[types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
)]
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>DeleteStarGiftCollectionRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="delete_star_gift_collection.html">DeleteStarGiftCollectionRequest</a></li></ul><h1>DeleteStarGiftCollectionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.deleteStarGiftCollection#ad5648e8 peer:<a href="../../types/input_peer.html">InputPeer</a> collection_id:<a href="../../index.html#int">int</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import DeleteStarGiftCollectionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>collection_id</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.DeleteStarGiftCollectionRequest(
|
||||
peer=<em>'username'</em>,
|
||||
collection_id=42
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,27 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>EditConnectedStarRefBotRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="edit_connected_star_ref_bot.html">EditConnectedStarRefBotRequest</a></li></ul><h1>EditConnectedStarRefBotRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.editConnectedStarRefBot#e4fca4a3 flags:# revoked:flags.0?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> link:<a href="../../index.html#string">string</a> = <a href="../../types/payments/connected_star_ref_bots.html">payments.ConnectedStarRefBots</a></pre><button onclick="cp('from telethon.tl.functions.payments import EditConnectedStarRefBotRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/connected_star_ref_bots.html">payments.ConnectedStarRefBots</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/connected_star_ref_bots.html">ConnectedStarRefBots</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>link</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>revoked</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.EditConnectedStarRefBotRequest(
|
||||
peer=<em>'username'</em>,
|
||||
link=<em>'some string here'</em>,
|
||||
revoked=<strong>True</strong>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,34 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ExportInvoiceRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="export_invoice.html">ExportInvoiceRequest</a></li></ul><h1>ExportInvoiceRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.exportInvoice#0f91b065 invoice_media:<a href="../../types/input_media.html">InputMedia</a> = <a href="../../types/payments/exported_invoice.html">payments.ExportedInvoice</a></pre><button onclick="cp('from telethon.tl.functions.payments import ExportInvoiceRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/exported_invoice.html">payments.ExportedInvoice</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/exported_invoice.html">ExportedInvoice</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>invoice_media</b></td><td style="text-align:center"><a href="../../types/input_media.html">InputMedia</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ExportInvoiceRequest(
|
||||
invoice_media=types.InputMediaUploadedPhoto(
|
||||
file=client.upload_file(<em>'/path/to/file.jpg'</em>),
|
||||
spoiler=<strong>True</strong>,
|
||||
stickers=[types.InputDocument(
|
||||
id=-12398745604826,
|
||||
access_hash=-12398745604826,
|
||||
file_reference=<em>b'arbitrary\x7f data \xfa here'</em>
|
||||
)],
|
||||
ttl_seconds=42
|
||||
)
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>FulfillStarsSubscriptionRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="fulfill_stars_subscription.html">FulfillStarsSubscriptionRequest</a></li></ul><h1>FulfillStarsSubscriptionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.fulfillStarsSubscription#cc5bebb3 peer:<a href="../../types/input_peer.html">InputPeer</a> subscription_id:<a href="../../index.html#string">string</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import FulfillStarsSubscriptionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>subscription_id</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.FulfillStarsSubscriptionRequest(
|
||||
peer=<em>'username'</em>,
|
||||
subscription_id=<em>'some string here'</em>
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetBankCardDataRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_bank_card_data.html">GetBankCardDataRequest</a></li></ul><h1>GetBankCardDataRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getBankCardData#2e79d779 number:<a href="../../index.html#string">string</a> = <a href="../../types/payments/bank_card_data.html">payments.BankCardData</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetBankCardDataRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/bank_card_data.html">payments.BankCardData</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/bank_card_data.html">BankCardData</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>number</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can cause 1 known error:</p><table><tr><td><code>BankCardNumberInvalidError</code></td><td>Incorrect credit card number.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetBankCardDataRequest(
|
||||
number=<em>'some string here'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetConnectedStarRefBotRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_connected_star_ref_bot.html">GetConnectedStarRefBotRequest</a></li></ul><h1>GetConnectedStarRefBotRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getConnectedStarRefBot#b7d998f0 peer:<a href="../../types/input_peer.html">InputPeer</a> bot:<a href="../../types/input_user.html">InputUser</a> = <a href="../../types/payments/connected_star_ref_bots.html">payments.ConnectedStarRefBots</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetConnectedStarRefBotRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/connected_star_ref_bots.html">payments.ConnectedStarRefBots</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/connected_star_ref_bots.html">ConnectedStarRefBots</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>bot</b></td><td style="text-align:center"><a href="../../types/input_user.html">InputUser</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetConnectedStarRefBotRequest(
|
||||
peer=<em>'username'</em>,
|
||||
bot=<em>'username'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,28 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetConnectedStarRefBotsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_connected_star_ref_bots.html">GetConnectedStarRefBotsRequest</a></li></ul><h1>GetConnectedStarRefBotsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getConnectedStarRefBots#5869a553 flags:# peer:<a href="../../types/input_peer.html">InputPeer</a> offset_date:flags.2?<a href="../../index.html#date">date</a> offset_link:flags.2?<a href="../../index.html#string">string</a> limit:<a href="../../index.html#int">int</a> = <a href="../../types/payments/connected_star_ref_bots.html">payments.ConnectedStarRefBots</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetConnectedStarRefBotsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/connected_star_ref_bots.html">payments.ConnectedStarRefBots</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/connected_star_ref_bots.html">ConnectedStarRefBots</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>limit</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>offset_date</b></td><td style="text-align:center"><a href="../../index.html#date">date</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>offset_link</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetConnectedStarRefBotsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
limit=100,
|
||||
offset_date=datetime.datetime(2018, 6, 25),
|
||||
offset_link=<em>'some string here'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetGiveawayInfoRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_giveaway_info.html">GetGiveawayInfoRequest</a></li></ul><h1>GetGiveawayInfoRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getGiveawayInfo#f4239425 peer:<a href="../../types/input_peer.html">InputPeer</a> msg_id:<a href="../../index.html#int">int</a> = <a href="../../types/payments/giveaway_info.html">payments.GiveawayInfo</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetGiveawayInfoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/giveaway_info.html">payments.GiveawayInfo</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/giveaway_info.html">GiveawayInfo</a></td><td><a href="../../constructors/payments/giveaway_info_results.html">GiveawayInfoResults</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>msg_id</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetGiveawayInfoRequest(
|
||||
peer=<em>'username'</em>,
|
||||
msg_id=42
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,31 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetPaymentFormRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_payment_form.html">GetPaymentFormRequest</a></li></ul><h1>GetPaymentFormRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getPaymentForm#37148dbb flags:# invoice:<a href="../../types/input_invoice.html">InputInvoice</a> theme_params:flags.0?<a href="../../types/data_json.html">DataJSON</a> = <a href="../../types/payments/payment_form.html">payments.PaymentForm</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetPaymentFormRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/payment_form.html">payments.PaymentForm</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/payment_form.html">PaymentForm</a></td><td><a href="../../constructors/payments/payment_form_star_gift.html">PaymentFormStarGift</a></td></tr><tr><td><a href="../../constructors/payments/payment_form_stars.html">PaymentFormStars</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>invoice</b></td><td style="text-align:center"><a href="../../types/input_invoice.html">InputInvoice</a></td><td></td></tr><tr><td><b>theme_params</b></td><td style="text-align:center"><a href="../../types/data_json.html">DataJSON</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 1 known error:</p><table><tr><td><code>MessageIdInvalidError</code></td><td>The specified message ID is invalid or you can't do that operation on such message.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetPaymentFormRequest(
|
||||
invoice=types.InputInvoiceMessage(
|
||||
peer=<em>'username'</em>,
|
||||
msg_id=42
|
||||
),
|
||||
theme_params=types.DataJSON(
|
||||
data=<em>'some string here'</em>
|
||||
)
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetPaymentReceiptRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_payment_receipt.html">GetPaymentReceiptRequest</a></li></ul><h1>GetPaymentReceiptRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getPaymentReceipt#2478d1cc peer:<a href="../../types/input_peer.html">InputPeer</a> msg_id:<a href="../../index.html#int">int</a> = <a href="../../types/payments/payment_receipt.html">payments.PaymentReceipt</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetPaymentReceiptRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/payment_receipt.html">payments.PaymentReceipt</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/payment_receipt.html">PaymentReceipt</a></td><td><a href="../../constructors/payments/payment_receipt_stars.html">PaymentReceiptStars</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>msg_id</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can cause 1 known error:</p><table><tr><td><code>MessageIdInvalidError</code></td><td>The specified message ID is invalid or you can't do that operation on such message.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetPaymentReceiptRequest(
|
||||
peer=<em>'username'</em>,
|
||||
msg_id=42
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetPremiumGiftCodeOptionsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_premium_gift_code_options.html">GetPremiumGiftCodeOptionsRequest</a></li></ul><h1>GetPremiumGiftCodeOptionsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getPremiumGiftCodeOptions#2757ba54 flags:# boost_peer:flags.0?<a href="../../types/input_peer.html">InputPeer</a> = <a href="../../index.html#vector">Vector</a><<a href="../../types/premium_gift_code_option.html">PremiumGiftCodeOption</a>></pre><button onclick="cp('from telethon.tl.functions.payments import GetPremiumGiftCodeOptionsRequest');">Copy import to the clipboard</button><h3>Returns</h3><p>A list of the following type is returned.</p><table><tr><td><a href="../../types/premium_gift_code_option.html">PremiumGiftCodeOption</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/premium_gift_code_option.html">PremiumGiftCodeOption</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>boost_peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>This argument defaults to <code>None</code> and can be omitted. Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetPremiumGiftCodeOptionsRequest(
|
||||
boost_peer=<em>'username'</em>
|
||||
))
|
||||
<strong>for</strong> x <strong>in</strong> result:
|
||||
print(x)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,33 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetResaleStarGiftsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_resale_star_gifts.html">GetResaleStarGiftsRequest</a></li></ul><h1>GetResaleStarGiftsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getResaleStarGifts#7a5fa236 flags:# sort_by_price:flags.1?<a href="../../index.html#true">true</a> sort_by_num:flags.2?<a href="../../index.html#true">true</a> attributes_hash:flags.0?<a href="../../index.html#long">long</a> gift_id:<a href="../../index.html#long">long</a> attributes:flags.3?<a href="../../index.html#vector">Vector</a><<a href="../../types/star_gift_attribute_id.html">StarGiftAttributeId</a>> offset:<a href="../../index.html#string">string</a> limit:<a href="../../index.html#int">int</a> = <a href="../../types/payments/resale_star_gifts.html">payments.ResaleStarGifts</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetResaleStarGiftsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/resale_star_gifts.html">payments.ResaleStarGifts</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/resale_star_gifts.html">ResaleStarGifts</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>gift_id</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr><tr><td><b>offset</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>limit</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>sort_by_price</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>sort_by_num</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>attributes_hash</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>attributes</b></td><td style="text-align:center"><a href="../../types/star_gift_attribute_id.html">StarGiftAttributeId</a></td><td>This argument defaults to <code>None</code> and can be omitted. Otherwise, a <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetResaleStarGiftsRequest(
|
||||
gift_id=-12398745604826,
|
||||
offset=<em>'some string here'</em>,
|
||||
limit=100,
|
||||
sort_by_price=<strong>True</strong>,
|
||||
sort_by_num=<strong>True</strong>,
|
||||
attributes_hash=-12398745604826,
|
||||
attributes=[types.StarGiftAttributeIdModel(
|
||||
document_id=-12398745604826
|
||||
)]
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,23 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetSavedInfoRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_saved_info.html">GetSavedInfoRequest</a></li></ul><h1>GetSavedInfoRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getSavedInfo#227d824b = <a href="../../types/payments/saved_info.html">payments.SavedInfo</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetSavedInfoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/saved_info.html">payments.SavedInfo</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/saved_info.html">SavedInfo</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetSavedInfoRequest())
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,27 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetSavedStarGiftRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_saved_star_gift.html">GetSavedStarGiftRequest</a></li></ul><h1>GetSavedStarGiftRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getSavedStarGift#b455a106 stargift:<a href="../../index.html#vector">Vector</a><<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a>> = <a href="../../types/payments/saved_star_gifts.html">payments.SavedStarGifts</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetSavedStarGiftRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/saved_star_gifts.html">payments.SavedStarGifts</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/saved_star_gifts.html">SavedStarGifts</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td>A <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetSavedStarGiftRequest(
|
||||
stargift=[types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
)]
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,37 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetSavedStarGiftsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_saved_star_gifts.html">GetSavedStarGiftsRequest</a></li></ul><h1>GetSavedStarGiftsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getSavedStarGifts#a319e569 flags:# exclude_unsaved:flags.0?<a href="../../index.html#true">true</a> exclude_saved:flags.1?<a href="../../index.html#true">true</a> exclude_unlimited:flags.2?<a href="../../index.html#true">true</a> exclude_unique:flags.4?<a href="../../index.html#true">true</a> sort_by_value:flags.5?<a href="../../index.html#true">true</a> exclude_upgradable:flags.7?<a href="../../index.html#true">true</a> exclude_unupgradable:flags.8?<a href="../../index.html#true">true</a> peer_color_available:flags.9?<a href="../../index.html#true">true</a> exclude_hosted:flags.10?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> collection_id:flags.6?<a href="../../index.html#int">int</a> offset:<a href="../../index.html#string">string</a> limit:<a href="../../index.html#int">int</a> = <a href="../../types/payments/saved_star_gifts.html">payments.SavedStarGifts</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetSavedStarGiftsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/saved_star_gifts.html">payments.SavedStarGifts</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/saved_star_gifts.html">SavedStarGifts</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>offset</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>limit</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>exclude_unsaved</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>exclude_saved</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>exclude_unlimited</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>exclude_unique</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>sort_by_value</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>exclude_upgradable</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>exclude_unupgradable</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>peer_color_available</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>exclude_hosted</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>collection_id</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetSavedStarGiftsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
offset=<em>'some string here'</em>,
|
||||
limit=100,
|
||||
exclude_unsaved=<strong>True</strong>,
|
||||
exclude_saved=<strong>True</strong>,
|
||||
exclude_unlimited=<strong>True</strong>,
|
||||
exclude_unique=<strong>True</strong>,
|
||||
sort_by_value=<strong>True</strong>,
|
||||
exclude_upgradable=<strong>True</strong>,
|
||||
exclude_unupgradable=<strong>True</strong>,
|
||||
peer_color_available=<strong>True</strong>,
|
||||
exclude_hosted=<strong>True</strong>,
|
||||
collection_id=42
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarGiftCollectionsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_star_gift_collections.html">GetStarGiftCollectionsRequest</a></li></ul><h1>GetStarGiftCollectionsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarGiftCollections#981b91dd peer:<a href="../../types/input_peer.html">InputPeer</a> hash:<a href="../../index.html#long">long</a> = <a href="../../types/payments/star_gift_collections.html">payments.StarGiftCollections</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarGiftCollectionsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/star_gift_collections.html">payments.StarGiftCollections</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/star_gift_collections.html">StarGiftCollections</a></td><td><a href="../../constructors/payments/star_gift_collections_not_modified.html">StarGiftCollectionsNotModified</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarGiftCollectionsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
hash=-12398745604826
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarGiftUpgradePreviewRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_star_gift_upgrade_preview.html">GetStarGiftUpgradePreviewRequest</a></li></ul><h1>GetStarGiftUpgradePreviewRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarGiftUpgradePreview#9c9abcb1 gift_id:<a href="../../index.html#long">long</a> = <a href="../../types/payments/star_gift_upgrade_preview.html">payments.StarGiftUpgradePreview</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarGiftUpgradePreviewRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/star_gift_upgrade_preview.html">payments.StarGiftUpgradePreview</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/star_gift_upgrade_preview.html">StarGiftUpgradePreview</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>gift_id</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarGiftUpgradePreviewRequest(
|
||||
gift_id=-12398745604826
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,32 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarGiftWithdrawalUrlRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_star_gift_withdrawal_url.html">GetStarGiftWithdrawalUrlRequest</a></li></ul><h1>GetStarGiftWithdrawalUrlRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarGiftWithdrawalUrl#d06e93a8 stargift:<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a> password:<a href="../../types/input_check_password_srp.html">InputCheckPasswordSRP</a> = <a href="../../types/payments/star_gift_withdrawal_url.html">payments.StarGiftWithdrawalUrl</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarGiftWithdrawalUrlRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/star_gift_withdrawal_url.html">payments.StarGiftWithdrawalUrl</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/star_gift_withdrawal_url.html">StarGiftWithdrawalUrl</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td></td></tr><tr><td><b>password</b></td><td style="text-align:center"><a href="../../types/input_check_password_srp.html">InputCheckPasswordSRP</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarGiftWithdrawalUrlRequest(
|
||||
stargift=types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
),
|
||||
password=types.InputCheckPasswordSRP(
|
||||
srp_id=-12398745604826,
|
||||
A=<em>b'arbitrary\x7f data \xfa here'</em>,
|
||||
M1=<em>b'arbitrary\x7f data \xfa here'</em>
|
||||
)
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarGiftsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_star_gifts.html">GetStarGiftsRequest</a></li></ul><h1>GetStarGiftsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarGifts#c4563590 hash:<a href="../../index.html#int">int</a> = <a href="../../types/payments/star_gifts.html">payments.StarGifts</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarGiftsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/star_gifts.html">payments.StarGifts</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/star_gifts.html">StarGifts</a></td><td><a href="../../constructors/payments/star_gifts_not_modified.html">StarGiftsNotModified</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarGiftsRequest(
|
||||
hash=0
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsGiftOptionsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_gift_options.html">GetStarsGiftOptionsRequest</a></li></ul><h1>GetStarsGiftOptionsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsGiftOptions#d3c96bc8 flags:# user_id:flags.0?<a href="../../types/input_user.html">InputUser</a> = <a href="../../index.html#vector">Vector</a><<a href="../../types/stars_gift_option.html">StarsGiftOption</a>></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsGiftOptionsRequest');">Copy import to the clipboard</button><h3>Returns</h3><p>A list of the following type is returned.</p><table><tr><td><a href="../../types/stars_gift_option.html">StarsGiftOption</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/stars_gift_option.html">StarsGiftOption</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>user_id</b></td><td style="text-align:center"><a href="../../types/input_user.html">InputUser</a></td><td>This argument defaults to <code>None</code> and can be omitted. Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsGiftOptionsRequest(
|
||||
user_id=<em>'username'</em>
|
||||
))
|
||||
<strong>for</strong> x <strong>in</strong> result:
|
||||
print(x)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,24 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsGiveawayOptionsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_giveaway_options.html">GetStarsGiveawayOptionsRequest</a></li></ul><h1>GetStarsGiveawayOptionsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsGiveawayOptions#bd1efd3e = <a href="../../index.html#vector">Vector</a><<a href="../../types/stars_giveaway_option.html">StarsGiveawayOption</a>></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsGiveawayOptionsRequest');">Copy import to the clipboard</button><h3>Returns</h3><p>A list of the following type is returned.</p><table><tr><td><a href="../../types/stars_giveaway_option.html">StarsGiveawayOption</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/stars_giveaway_option.html">StarsGiveawayOption</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsGiveawayOptionsRequest())
|
||||
<strong>for</strong> x <strong>in</strong> result:
|
||||
print(x)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsRevenueAdsAccountUrlRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_revenue_ads_account_url.html">GetStarsRevenueAdsAccountUrlRequest</a></li></ul><h1>GetStarsRevenueAdsAccountUrlRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsRevenueAdsAccountUrl#d1d7efc5 peer:<a href="../../types/input_peer.html">InputPeer</a> = <a href="../../types/payments/stars_revenue_ads_account_url.html">payments.StarsRevenueAdsAccountUrl</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsRevenueAdsAccountUrlRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/stars_revenue_ads_account_url.html">payments.StarsRevenueAdsAccountUrl</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/stars_revenue_ads_account_url.html">StarsRevenueAdsAccountUrl</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsRevenueAdsAccountUrlRequest(
|
||||
peer=<em>'username'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,27 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsRevenueStatsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_revenue_stats.html">GetStarsRevenueStatsRequest</a></li></ul><h1>GetStarsRevenueStatsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsRevenueStats#d91ffad6 flags:# dark:flags.0?<a href="../../index.html#true">true</a> ton:flags.1?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> = <a href="../../types/payments/stars_revenue_stats.html">payments.StarsRevenueStats</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsRevenueStatsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/stars_revenue_stats.html">payments.StarsRevenueStats</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/stars_revenue_stats.html">StarsRevenueStats</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>dark</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>ton</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsRevenueStatsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
dark=<strong>True</strong>,
|
||||
ton=<strong>True</strong>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,32 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsRevenueWithdrawalUrlRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_revenue_withdrawal_url.html">GetStarsRevenueWithdrawalUrlRequest</a></li></ul><h1>GetStarsRevenueWithdrawalUrlRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsRevenueWithdrawalUrl#2433dc92 flags:# ton:flags.0?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> amount:flags.1?<a href="../../index.html#long">long</a> password:<a href="../../types/input_check_password_srp.html">InputCheckPasswordSRP</a> = <a href="../../types/payments/stars_revenue_withdrawal_url.html">payments.StarsRevenueWithdrawalUrl</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsRevenueWithdrawalUrlRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/stars_revenue_withdrawal_url.html">payments.StarsRevenueWithdrawalUrl</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/stars_revenue_withdrawal_url.html">StarsRevenueWithdrawalUrl</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>password</b></td><td style="text-align:center"><a href="../../types/input_check_password_srp.html">InputCheckPasswordSRP</a></td><td></td></tr><tr><td><b>ton</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>amount</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsRevenueWithdrawalUrlRequest(
|
||||
peer=<em>'username'</em>,
|
||||
password=types.InputCheckPasswordSRP(
|
||||
srp_id=-12398745604826,
|
||||
A=<em>b'arbitrary\x7f data \xfa here'</em>,
|
||||
M1=<em>b'arbitrary\x7f data \xfa here'</em>
|
||||
),
|
||||
ton=<strong>True</strong>,
|
||||
amount=-12398745604826
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsStatusRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_status.html">GetStarsStatusRequest</a></li></ul><h1>GetStarsStatusRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsStatus#4ea9b3bf flags:# ton:flags.0?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> = <a href="../../types/payments/stars_status.html">payments.StarsStatus</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsStatusRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/stars_status.html">payments.StarsStatus</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/stars_status.html">StarsStatus</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>ton</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsStatusRequest(
|
||||
peer=<em>'username'</em>,
|
||||
ton=<strong>True</strong>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,27 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsSubscriptionsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_subscriptions.html">GetStarsSubscriptionsRequest</a></li></ul><h1>GetStarsSubscriptionsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsSubscriptions#032512c5 flags:# missing_balance:flags.0?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> offset:<a href="../../index.html#string">string</a> = <a href="../../types/payments/stars_status.html">payments.StarsStatus</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsSubscriptionsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/stars_status.html">payments.StarsStatus</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/stars_status.html">StarsStatus</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>offset</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>missing_balance</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsSubscriptionsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
offset=<em>'some string here'</em>,
|
||||
missing_balance=<strong>True</strong>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,24 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsTopupOptionsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_topup_options.html">GetStarsTopupOptionsRequest</a></li></ul><h1>GetStarsTopupOptionsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsTopupOptions#c00ec7d3 = <a href="../../index.html#vector">Vector</a><<a href="../../types/stars_topup_option.html">StarsTopupOption</a>></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsTopupOptionsRequest');">Copy import to the clipboard</button><h3>Returns</h3><p>A list of the following type is returned.</p><table><tr><td><a href="../../types/stars_topup_option.html">StarsTopupOption</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/stars_topup_option.html">StarsTopupOption</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsTopupOptionsRequest())
|
||||
<strong>for</strong> x <strong>in</strong> result:
|
||||
print(x)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,32 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsTransactionsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_transactions.html">GetStarsTransactionsRequest</a></li></ul><h1>GetStarsTransactionsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsTransactions#69da4557 flags:# inbound:flags.0?<a href="../../index.html#true">true</a> outbound:flags.1?<a href="../../index.html#true">true</a> ascending:flags.2?<a href="../../index.html#true">true</a> ton:flags.4?<a href="../../index.html#true">true</a> subscription_id:flags.3?<a href="../../index.html#string">string</a> peer:<a href="../../types/input_peer.html">InputPeer</a> offset:<a href="../../index.html#string">string</a> limit:<a href="../../index.html#int">int</a> = <a href="../../types/payments/stars_status.html">payments.StarsStatus</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsTransactionsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/stars_status.html">payments.StarsStatus</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/stars_status.html">StarsStatus</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>offset</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>limit</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>inbound</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>outbound</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>ascending</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>ton</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>subscription_id</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsTransactionsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
offset=<em>'some string here'</em>,
|
||||
limit=100,
|
||||
inbound=<strong>True</strong>,
|
||||
outbound=<strong>True</strong>,
|
||||
ascending=<strong>True</strong>,
|
||||
ton=<strong>True</strong>,
|
||||
subscription_id=<em>'some string here'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,30 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetStarsTransactionsByIDRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_stars_transactions_by_id.html">GetStarsTransactionsByIDRequest</a></li></ul><h1>GetStarsTransactionsByIDRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getStarsTransactionsByID#2dca16b8 flags:# ton:flags.0?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> id:<a href="../../index.html#vector">Vector</a><<a href="../../types/input_stars_transaction.html">InputStarsTransaction</a>> = <a href="../../types/payments/stars_status.html">payments.StarsStatus</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetStarsTransactionsByIDRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/stars_status.html">payments.StarsStatus</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/stars_status.html">StarsStatus</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>id</b></td><td style="text-align:center"><a href="../../types/input_stars_transaction.html">InputStarsTransaction</a></td><td>A <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr><tr><td><b>ton</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetStarsTransactionsByIDRequest(
|
||||
peer=<em>'username'</em>,
|
||||
id=[types.InputStarsTransaction(
|
||||
id=<em>'some string here'</em>,
|
||||
refund=<strong>True</strong>
|
||||
)],
|
||||
ton=<strong>True</strong>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,29 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetSuggestedStarRefBotsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_suggested_star_ref_bots.html">GetSuggestedStarRefBotsRequest</a></li></ul><h1>GetSuggestedStarRefBotsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getSuggestedStarRefBots#0d6b48f7 flags:# order_by_revenue:flags.0?<a href="../../index.html#true">true</a> order_by_date:flags.1?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> offset:<a href="../../index.html#string">string</a> limit:<a href="../../index.html#int">int</a> = <a href="../../types/payments/suggested_star_ref_bots.html">payments.SuggestedStarRefBots</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetSuggestedStarRefBotsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/suggested_star_ref_bots.html">payments.SuggestedStarRefBots</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/suggested_star_ref_bots.html">SuggestedStarRefBots</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>offset</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>limit</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>order_by_revenue</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>order_by_date</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetSuggestedStarRefBotsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
offset=<em>'some string here'</em>,
|
||||
limit=100,
|
||||
order_by_revenue=<strong>True</strong>,
|
||||
order_by_date=<strong>True</strong>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetUniqueStarGiftRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_unique_star_gift.html">GetUniqueStarGiftRequest</a></li></ul><h1>GetUniqueStarGiftRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getUniqueStarGift#a1974d72 slug:<a href="../../index.html#string">string</a> = <a href="../../types/payments/unique_star_gift.html">payments.UniqueStarGift</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetUniqueStarGiftRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/unique_star_gift.html">payments.UniqueStarGift</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/unique_star_gift.html">UniqueStarGift</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>slug</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetUniqueStarGiftRequest(
|
||||
slug=<em>'some string here'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>GetUniqueStarGiftValueInfoRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_unique_star_gift_value_info.html">GetUniqueStarGiftValueInfoRequest</a></li></ul><h1>GetUniqueStarGiftValueInfoRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.getUniqueStarGiftValueInfo#4365af6b slug:<a href="../../index.html#string">string</a> = <a href="../../types/payments/unique_star_gift_value_info.html">payments.UniqueStarGiftValueInfo</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetUniqueStarGiftValueInfoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/unique_star_gift_value_info.html">payments.UniqueStarGiftValueInfo</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/unique_star_gift_value_info.html">UniqueStarGiftValueInfo</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>slug</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.GetUniqueStarGiftValueInfoRequest(
|
||||
slug=<em>'some string here'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,30 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>LaunchPrepaidGiveawayRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="launch_prepaid_giveaway.html">LaunchPrepaidGiveawayRequest</a></li></ul><h1>LaunchPrepaidGiveawayRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.launchPrepaidGiveaway#5ff58f20 peer:<a href="../../types/input_peer.html">InputPeer</a> giveaway_id:<a href="../../index.html#long">long</a> purpose:<a href="../../types/input_store_payment_purpose.html">InputStorePaymentPurpose</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.payments import LaunchPrepaidGiveawayRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>giveaway_id</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr><tr><td><b>purpose</b></td><td style="text-align:center"><a href="../../types/input_store_payment_purpose.html">InputStorePaymentPurpose</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.LaunchPrepaidGiveawayRequest(
|
||||
peer=<em>'username'</em>,
|
||||
giveaway_id=-12398745604826,
|
||||
purpose=types.InputStorePaymentPremiumSubscription(
|
||||
restore=<strong>True</strong>,
|
||||
upgrade=<strong>True</strong>
|
||||
)
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>RefundStarsChargeRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="refund_stars_charge.html">RefundStarsChargeRequest</a></li></ul><h1>RefundStarsChargeRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.refundStarsCharge#25ae8f4a user_id:<a href="../../types/input_user.html">InputUser</a> charge_id:<a href="../../index.html#string">string</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.payments import RefundStarsChargeRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>user_id</b></td><td style="text-align:center"><a href="../../types/input_user.html">InputUser</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>charge_id</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.RefundStarsChargeRequest(
|
||||
user_id=<em>'username'</em>,
|
||||
charge_id=<em>'some string here'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ReorderStarGiftCollectionsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="reorder_star_gift_collections.html">ReorderStarGiftCollectionsRequest</a></li></ul><h1>ReorderStarGiftCollectionsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.reorderStarGiftCollections#c32af4cc peer:<a href="../../types/input_peer.html">InputPeer</a> order:<a href="../../index.html#vector">Vector</a><<a href="../../index.html#int">int</a>> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import ReorderStarGiftCollectionsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>order</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td>A <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ReorderStarGiftCollectionsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
order=[42]
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,28 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>SaveStarGiftRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="save_star_gift.html">SaveStarGiftRequest</a></li></ul><h1>SaveStarGiftRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.saveStarGift#2a2a697c flags:# unsave:flags.0?<a href="../../index.html#true">true</a> stargift:<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import SaveStarGiftRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td></td></tr><tr><td><b>unsave</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.SaveStarGiftRequest(
|
||||
stargift=types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
),
|
||||
unsave=<strong>True</strong>
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,36 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>SendPaymentFormRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="send_payment_form.html">SendPaymentFormRequest</a></li></ul><h1>SendPaymentFormRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.sendPaymentForm#2d03522f flags:# form_id:<a href="../../index.html#long">long</a> invoice:<a href="../../types/input_invoice.html">InputInvoice</a> requested_info_id:flags.0?<a href="../../index.html#string">string</a> shipping_option_id:flags.1?<a href="../../index.html#string">string</a> credentials:<a href="../../types/input_payment_credentials.html">InputPaymentCredentials</a> tip_amount:flags.2?<a href="../../index.html#long">long</a> = <a href="../../types/payments/payment_result.html">payments.PaymentResult</a></pre><button onclick="cp('from telethon.tl.functions.payments import SendPaymentFormRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/payment_result.html">payments.PaymentResult</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/payment_result.html">PaymentResult</a></td><td><a href="../../constructors/payments/payment_verification_needed.html">PaymentVerificationNeeded</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>form_id</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr><tr><td><b>invoice</b></td><td style="text-align:center"><a href="../../types/input_invoice.html">InputInvoice</a></td><td></td></tr><tr><td><b>credentials</b></td><td style="text-align:center"><a href="../../types/input_payment_credentials.html">InputPaymentCredentials</a></td><td></td></tr><tr><td><b>requested_info_id</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>shipping_option_id</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>tip_amount</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 1 known error:</p><table><tr><td><code>MessageIdInvalidError</code></td><td>The specified message ID is invalid or you can't do that operation on such message.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.SendPaymentFormRequest(
|
||||
form_id=-12398745604826,
|
||||
invoice=types.InputInvoiceMessage(
|
||||
peer=<em>'username'</em>,
|
||||
msg_id=42
|
||||
),
|
||||
credentials=types.InputPaymentCredentialsSaved(
|
||||
id=<em>'some string here'</em>,
|
||||
tmp_password=<em>b'arbitrary\x7f data \xfa here'</em>
|
||||
),
|
||||
requested_info_id=<em>'some string here'</em>,
|
||||
shipping_option_id=<em>'some string here'</em>,
|
||||
tip_amount=-12398745604826
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,29 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>SendStarsFormRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="send_stars_form.html">SendStarsFormRequest</a></li></ul><h1>SendStarsFormRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.sendStarsForm#7998c914 form_id:<a href="../../index.html#long">long</a> invoice:<a href="../../types/input_invoice.html">InputInvoice</a> = <a href="../../types/payments/payment_result.html">payments.PaymentResult</a></pre><button onclick="cp('from telethon.tl.functions.payments import SendStarsFormRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/payment_result.html">payments.PaymentResult</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/payment_result.html">PaymentResult</a></td><td><a href="../../constructors/payments/payment_verification_needed.html">PaymentVerificationNeeded</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>form_id</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr><tr><td><b>invoice</b></td><td style="text-align:center"><a href="../../types/input_invoice.html">InputInvoice</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.SendStarsFormRequest(
|
||||
form_id=-12398745604826,
|
||||
invoice=types.InputInvoiceMessage(
|
||||
peer=<em>'username'</em>,
|
||||
msg_id=42
|
||||
)
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,26 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ToggleChatStarGiftNotificationsRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="toggle_chat_star_gift_notifications.html">ToggleChatStarGiftNotificationsRequest</a></li></ul><h1>ToggleChatStarGiftNotificationsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.toggleChatStarGiftNotifications#60eaefa1 flags:# enabled:flags.0?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import ToggleChatStarGiftNotificationsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>enabled</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ToggleChatStarGiftNotificationsRequest(
|
||||
peer=<em>'username'</em>,
|
||||
enabled=<strong>True</strong>
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,28 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ToggleStarGiftsPinnedToTopRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="toggle_star_gifts_pinned_to_top.html">ToggleStarGiftsPinnedToTopRequest</a></li></ul><h1>ToggleStarGiftsPinnedToTopRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.toggleStarGiftsPinnedToTop#1513e7b0 peer:<a href="../../types/input_peer.html">InputPeer</a> stargift:<a href="../../index.html#vector">Vector</a><<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a>> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.payments import ToggleStarGiftsPinnedToTopRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td>A <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ToggleStarGiftsPinnedToTopRequest(
|
||||
peer=<em>'username'</em>,
|
||||
stargift=[types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
)]
|
||||
))
|
||||
print(result)</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,28 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>TransferStarGiftRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="transfer_star_gift.html">TransferStarGiftRequest</a></li></ul><h1>TransferStarGiftRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.transferStarGift#7f18176a stargift:<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a> to_id:<a href="../../types/input_peer.html">InputPeer</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.payments import TransferStarGiftRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td></td></tr><tr><td><b>to_id</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.TransferStarGiftRequest(
|
||||
stargift=types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
),
|
||||
to_id=<em>'username'</em>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,36 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>UpdateStarGiftCollectionRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="update_star_gift_collection.html">UpdateStarGiftCollectionRequest</a></li></ul><h1>UpdateStarGiftCollectionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.updateStarGiftCollection#4fddbee7 flags:# peer:<a href="../../types/input_peer.html">InputPeer</a> collection_id:<a href="../../index.html#int">int</a> title:flags.0?<a href="../../index.html#string">string</a> delete_stargift:flags.1?<a href="../../index.html#vector">Vector</a><<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a>> add_stargift:flags.2?<a href="../../index.html#vector">Vector</a><<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a>> order:flags.3?<a href="../../index.html#vector">Vector</a><<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a>> = <a href="../../types/star_gift_collection.html">StarGiftCollection</a></pre><button onclick="cp('from telethon.tl.functions.payments import UpdateStarGiftCollectionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/star_gift_collection.html">StarGiftCollection</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/star_gift_collection.html">StarGiftCollection</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>collection_id</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>title</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>delete_stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td>This argument defaults to <code>None</code> and can be omitted. Otherwise, a <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr><tr><td><b>add_stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td>This argument defaults to <code>None</code> and can be omitted. Otherwise, a <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr><tr><td><b>order</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td>This argument defaults to <code>None</code> and can be omitted. Otherwise, a <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.UpdateStarGiftCollectionRequest(
|
||||
peer=<em>'username'</em>,
|
||||
collection_id=42,
|
||||
title=<em>'My awesome title'</em>,
|
||||
delete_stargift=[types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
)],
|
||||
add_stargift=[types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
)],
|
||||
order=[types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
)]
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,31 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>UpdateStarGiftPriceRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="update_star_gift_price.html">UpdateStarGiftPriceRequest</a></li></ul><h1>UpdateStarGiftPriceRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.updateStarGiftPrice#edbe6ccb stargift:<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a> resell_amount:<a href="../../types/stars_amount.html">StarsAmount</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.payments import UpdateStarGiftPriceRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td></td></tr><tr><td><b>resell_amount</b></td><td style="text-align:center"><a href="../../types/stars_amount.html">StarsAmount</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.UpdateStarGiftPriceRequest(
|
||||
stargift=types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
),
|
||||
resell_amount=types.StarsAmount(
|
||||
amount=-12398745604826,
|
||||
nanos=42
|
||||
)
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,28 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>UpgradeStarGiftRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="upgrade_star_gift.html">UpgradeStarGiftRequest</a></li></ul><h1>UpgradeStarGiftRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.upgradeStarGift#aed6e4f5 flags:# keep_original_details:flags.0?<a href="../../index.html#true">true</a> stargift:<a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.payments import UpgradeStarGiftRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>stargift</b></td><td style="text-align:center"><a href="../../types/input_saved_star_gift.html">InputSavedStarGift</a></td><td></td></tr><tr><td><b>keep_original_details</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.UpgradeStarGiftRequest(
|
||||
stargift=types.InputSavedStarGiftUser(
|
||||
msg_id=42
|
||||
),
|
||||
keep_original_details=<strong>True</strong>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
@@ -0,0 +1,42 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>ValidateRequestedInfoRequest</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
|
||||
<script>
|
||||
document.getElementById("style").href = "../../css/docs."
|
||||
+ (localStorage.getItem("theme") || "light")
|
||||
+ ".css";
|
||||
</script>
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
|
||||
rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="validate_requested_info.html">ValidateRequestedInfoRequest</a></li></ul><h1>ValidateRequestedInfoRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||||
payments.validateRequestedInfo#b6c8f12b flags:# save:flags.0?<a href="../../index.html#true">true</a> invoice:<a href="../../types/input_invoice.html">InputInvoice</a> info:<a href="../../types/payment_requested_info.html">PaymentRequestedInfo</a> = <a href="../../types/payments/validated_requested_info.html">payments.ValidatedRequestedInfo</a></pre><button onclick="cp('from telethon.tl.functions.payments import ValidateRequestedInfoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/validated_requested_info.html">payments.ValidatedRequestedInfo</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/payments/validated_requested_info.html">ValidatedRequestedInfo</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>invoice</b></td><td style="text-align:center"><a href="../../types/input_invoice.html">InputInvoice</a></td><td></td></tr><tr><td><b>info</b></td><td style="text-align:center"><a href="../../types/payment_requested_info.html">PaymentRequestedInfo</a></td><td></td></tr><tr><td><b>save</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 1 known error:</p><table><tr><td><code>MessageIdInvalidError</code></td><td>The specified message ID is invalid or you can't do that operation on such message.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
|
||||
<strong>from</strong> telethon <strong>import</strong> functions, types
|
||||
|
||||
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
|
||||
result = client(functions.payments.ValidateRequestedInfoRequest(
|
||||
invoice=types.InputInvoiceMessage(
|
||||
peer=<em>'username'</em>,
|
||||
msg_id=42
|
||||
),
|
||||
info=types.PaymentRequestedInfo(
|
||||
name=<em>'some string here'</em>,
|
||||
phone=<em>'some string here'</em>,
|
||||
email=<em>'some string here'</em>,
|
||||
shipping_address=types.PostAddress(
|
||||
street_line1=<em>'some string here'</em>,
|
||||
street_line2=<em>'some string here'</em>,
|
||||
city=<em>'some string here'</em>,
|
||||
state=<em>'some string here'</em>,
|
||||
country_iso2=<em>'some string here'</em>,
|
||||
post_code=<em>'some string here'</em>
|
||||
)
|
||||
),
|
||||
save=<strong>True</strong>
|
||||
))
|
||||
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>
|
||||
Reference in New Issue
Block a user