Update content of files

This commit is contained in:
GitHub Action 2024-08-03 17:32:39 +00:00
parent 51371a558e
commit fadde3e881
7 changed files with 42 additions and 64 deletions

View file

@ -97,9 +97,9 @@
</ul>
<h5><a class="anchor" href="#new-constructors" id="new-constructors" name="new-constructors"><i class="anchor-icon"></i></a>New Constructors</h5>
<ul>
<li>Added <a href="/constructor/inputStorePaymentStarsTopup">inputStorePaymentStarsTopup</a> - Used to top up the <a href="/api/stars">Telegram Stars balance</a> using the Play Store/App Store flow (official apps only).</li>
<li>Added <a href="/constructor/inputStorePaymentStarsGift">inputStorePaymentStarsGift</a> - Used to top up the <a href="/api/stars">Telegram Stars</a> balance of a friend using the Play Store/App Store flow (official apps only).</li>
<li>Added <a href="/constructor/starsGiftOption">starsGiftOption</a> - </li>
<li>Added <a href="/constructor/inputStorePaymentStarsTopup">inputStorePaymentStarsTopup</a> - Used to top up the <a href="/api/stars">Telegram Stars balance</a> of the current account.</li>
<li>Added <a href="/constructor/inputStorePaymentStarsGift">inputStorePaymentStarsGift</a> - Used to gift <a href="/api/stars">Telegram Stars</a> to a friend.</li>
<li>Added <a href="/constructor/starsGiftOption">starsGiftOption</a> - <a href="/api/stars#buying-stars">Telegram Stars gift option</a>.</li>
<li>Added <a href="/constructor/messageActionGiftStars">messageActionGiftStars</a> - </li>
<li>Added <a href="/constructor/topPeerCategoryBotsApp">topPeerCategoryBotsApp</a> - </li>
<li>Added <a href="/constructor/bots.popularAppBots">bots.popularAppBots</a> - </li>
@ -318,7 +318,7 @@ If the returned <a href="/constructor/webViewResultUrl">webViewResultUrl</a> doe
<li>Added <a href="/constructor/starsTransactionPeer">starsTransactionPeer</a> - Describes a <a href="/api/stars">Telegram Star</a> transaction with another peer.</li>
<li>Added <a href="/constructor/inputStorePaymentStars">inputStorePaymentStars</a> - Used to top up the <a href="/api/stars">Telegram Stars balance</a> using the Play Store/App Store flow (official apps only).</li>
<li>Added <a href="/constructor/starsTopupOption">starsTopupOption</a> - <a href="/api/stars">Telegram Stars topup option</a>.</li>
<li>Added <a href="/constructor/inputInvoiceStars">inputInvoiceStars</a> - Used to top up the current account's <a href="/api/stars">Telegram Stars</a> balance.</li>
<li>Added <a href="/constructor/inputInvoiceStars">inputInvoiceStars</a> - Used to top up the <a href="/api/stars">Telegram Stars</a> balance of the current account or someone else's account.</li>
<li>Added <a href="/constructor/starsTransaction">starsTransaction</a> - Represents a <a href="/api/stars">Telegram Stars transaction »</a>.</li>
<li>Added <a href="/constructor/payments.starsStatus">payments.starsStatus</a> - Info about the current <a href="/api/stars#balance-and-transaction-history">Telegram Star balance and transaction history »</a>.</li>
<li>Added <a href="/constructor/updateStarsBalance">updateStarsBalance</a> - The current account's <a href="/api/stars">Telegram Stars balance »</a> has changed.</li>

View file

@ -98,13 +98,21 @@ To return all <a href="/constructor/starsTransaction">star transactions »</a> (
<h3><a class="anchor" href="#buying-stars" id="buying-stars" name="buying-stars"><i class="anchor-icon"></i></a>Buying stars</h3>
<pre><code><a href='/constructor/starsTopupOption'>starsTopupOption</a>#bd915c0 flags:<a href='/type/%23'>#</a> extended:flags.1?<a href='/constructor/true'>true</a> stars:<a href='/type/long'>long</a> store_product:flags.0?<a href='/type/string'>string</a> currency:<a href='/type/string'>string</a> amount:<a href='/type/long'>long</a> = <a href='/type/StarsTopupOption'>StarsTopupOption</a>;
<a href='/constructor/starsGiftOption'>starsGiftOption</a>#5e0589f1 flags:<a href='/type/%23'>#</a> extended:flags.1?<a href='/constructor/true'>true</a> stars:<a href='/type/long'>long</a> store_product:flags.0?<a href='/type/string'>string</a> currency:<a href='/type/string'>string</a> amount:<a href='/type/long'>long</a> = <a href='/type/StarsGiftOption'>StarsGiftOption</a>;
<a href='/constructor/inputStorePaymentStarsTopup'>inputStorePaymentStarsTopup</a>#dddd0f56 stars:<a href='/type/long'>long</a> currency:<a href='/type/string'>string</a> amount:<a href='/type/long'>long</a> = <a href='/type/InputStorePaymentPurpose'>InputStorePaymentPurpose</a>;
<a href='/constructor/inputStorePaymentStarsGift'>inputStorePaymentStarsGift</a>#1d741ef7 user_id:<a href='/type/InputUser'>InputUser</a> stars:<a href='/type/long'>long</a> currency:<a href='/type/string'>string</a> amount:<a href='/type/long'>long</a> = <a href='/type/InputStorePaymentPurpose'>InputStorePaymentPurpose</a>;
<a href='/constructor/inputInvoiceStars'>inputInvoiceStars</a>#65f00ce3 purpose:<a href='/type/InputStorePaymentPurpose'>InputStorePaymentPurpose</a> = <a href='/type/InputInvoice'>InputInvoice</a>;
---functions---
<a href='/method/payments.getStarsTopupOptions'>payments.getStarsTopupOptions</a>#c00ec7d3 = <a href='/type/Vector%20t'>Vector</a>&lt;<a href='/type/StarsTopupOption'>StarsTopupOption</a>&gt;;</code></pre>
<p>To purchase telegram stars, first invoke the <a href="/method/payments.getStarsTopupOptions">payments.getStarsTopupOptions</a> method, to obtain a list of topup options as <a href="/constructor/starsTopupOption">starsTopupOption</a> constructors. </p>
<p>Once the user has chosen a specific star topup option, invoke <a href="/method/payments.getPaymentForm">payments.getPaymentForm</a>, passing an <a href="/constructor/inputInvoiceStars">inputInvoiceStars</a>, with the chosen <a href="/constructor/starsTopupOption">starsTopupOption</a>.</p>
<a href='/method/payments.getStarsTopupOptions'>payments.getStarsTopupOptions</a>#c00ec7d3 = <a href='/type/Vector%20t'>Vector</a>&lt;<a href='/type/StarsTopupOption'>StarsTopupOption</a>&gt;;
<a href='/method/payments.getStarsGiftOptions'>payments.getStarsGiftOptions</a>#d3c96bc8 flags:<a href='/type/%23'>#</a> user_id:flags.0?<a href='/type/InputUser'>InputUser</a> = <a href='/type/Vector%20t'>Vector</a>&lt;<a href='/type/StarsGiftOption'>StarsGiftOption</a>&gt;;</code></pre>
<p>To purchase telegram stars for ourselves, first invoke the <a href="/method/payments.getStarsTopupOptions">payments.getStarsTopupOptions</a> method, to obtain a list of topup options as <a href="/constructor/starsTopupOption">starsTopupOption</a> constructors. </p>
<p>To purchase telegram stars for a friend, first invoke the <a href="/method/payments.getStarsGiftOptions">payments.getStarsGiftOptions</a> method, to obtain a list of gift options as <a href="/constructor/starsGiftOption">starsGiftOption</a> constructors. </p>
<p>Once the user has chosen a specific star topup/gift option, invoke <a href="/method/payments.getPaymentForm">payments.getPaymentForm</a>, passing an <a href="/constructor/inputInvoiceStars">inputInvoiceStars</a>, with either <a href="/constructor/inputStorePaymentStarsTopup">inputStorePaymentStarsTopup</a> or <a href="/constructor/inputStorePaymentStarsGift">inputStorePaymentStarsGift</a>, populated with the values from the chosen <a href="/constructor/starsTopupOption">starsTopupOption</a>/<a href="/constructor/starsGiftOption">starsGiftOption</a>.</p>
<p>Then, follow the <a href="/api/payments#22-getting-invoice-info-about-the-product">invoice payment flow as described in the payments documentation »</a>. </p>
<p>More alternative payment flows are also available:</p>
<ul>

View file

@ -4,36 +4,10 @@
<meta charset="utf-8">
<title>starsGiftOption</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta property="description" content="Parameters
Name
Type
Description
flags
#
Flags, see TL conditional fields
extended
flags.1?true
 
stars
long
 
store_product…">
<meta property="description" content="Telegram Stars gift option.">
<meta property="og:title" content="starsGiftOption">
<meta property="og:image" content="">
<meta property="og:description" content="Parameters
Name
Type
Description
flags
#
Flags, see TL conditional fields
extended
flags.1?true
 
stars
long
 
store_product…">
<meta property="og:description" content="Telegram Stars gift option.">
<link rel="icon" type="image/svg+xml" href="/img/website_icon.svg?4">
<link rel="apple-touch-icon" sizes="180x180" href="/img/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/img/favicon-32x32.png">
@ -68,7 +42,8 @@ store_product…">
<div class="dev_page_bread_crumbs"><ul class="breadcrumb clearfix"><li><a href="/api" >API</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/schema" >TL-schema</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/constructor/starsGiftOption" >starsGiftOption</a></li></ul></div>
<h1 id="dev_page_title">starsGiftOption</h1>
<div id="dev_page_content"><p><div class="clearfix">
<div id="dev_page_content"><p><a href="/api/stars#buying-stars">Telegram Stars gift option</a>.</p>
<p><div class="clearfix">
<ul class="dev_layer_select slightly-pull-right nav nav-pills">
<li class="dropdown">
<a class="dropdown-toggle" onclick="return dropdownClick(this, event)" href="#">Layer 185 <b class="caret"></b></a>
@ -99,32 +74,36 @@ store_product…">
<tr>
<td><strong>extended</strong></td>
<td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.1?<a href="/constructor/true">true</a></td>
<td> </td>
<td>If set, the option must only be shown in the full list of topup options.</td>
</tr>
<tr>
<td><strong>stars</strong></td>
<td style="text-align: center;"><a href="/type/long">long</a></td>
<td> </td>
<td>Amount of Telegram stars.</td>
</tr>
<tr>
<td><strong>store_product</strong></td>
<td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.0?<a href="/type/string">string</a></td>
<td> </td>
<td>Identifier of the store product associated with the option, official apps only.</td>
</tr>
<tr>
<td><strong>currency</strong></td>
<td style="text-align: center;"><a href="/type/string">string</a></td>
<td> </td>
<td>Three-letter ISO 4217 <a href="/bots/payments#supported-currencies">currency</a> code</td>
</tr>
<tr>
<td><strong>amount</strong></td>
<td style="text-align: center;"><a href="/type/long">long</a></td>
<td> </td>
<td>Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of <code>US$ 1.45</code> pass <code>amount = 145</code>. See the exp parameter in <a href="/bots/payments/currencies.json">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).</td>
</tr>
</tbody>
</table>
<h3><a class="anchor" href="#type" id="type" name="type"><i class="anchor-icon"></i></a>Type</h3>
<p><a href="/type/StarsGiftOption">StarsGiftOption</a></p></div>
<p><a href="/type/StarsGiftOption">StarsGiftOption</a></p>
<h3><a class="anchor" href="#related-pages" id="related-pages" name="related-pages"><i class="anchor-icon"></i></a>Related pages</h3>
<h4><a class="anchor" href="#bot-payments-api" id="bot-payments-api" name="bot-payments-api"><i class="anchor-icon"></i></a><a href="/bots/payments">Bot Payments API</a></h4>
<h4><a class="anchor" href="#telegram-stars" id="telegram-stars" name="telegram-stars"><i class="anchor-icon"></i></a><a href="/api/stars">Telegram Stars</a></h4>
<p>Telegram Stars are an in-app currency that allows the user to pay for digital goods and services offered by Telegram bots or Telegram channels.</p></div>
</div>

View file

@ -64,7 +64,7 @@
<h4><a class="anchor" href="#telegram-stars" id="telegram-stars" name="telegram-stars"><i class="anchor-icon"></i></a><a href="/api/stars">Telegram Stars</a></h4>
<p>Telegram Stars are an in-app currency that allows the user to pay for digital goods and services offered by Telegram bots or Telegram channels.</p>
<h4><a class="anchor" href="#inputinvoicestars" id="inputinvoicestars" name="inputinvoicestars"><i class="anchor-icon"></i></a><a href="/constructor/inputInvoiceStars">inputInvoiceStars</a></h4>
<p>Used to top up the current account's <a href="/api/stars">Telegram Stars</a> balance.</p></div>
<p>Used to top up the <a href="/api/stars">Telegram Stars</a> balance of the current account or someone else's account.</p></div>
</div>

View file

@ -4,32 +4,22 @@
<meta charset="utf-8">
<title>payments.getStarsGiftOptions</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta property="description" content="Parameters
<meta property="description" content="Obtain a list of Telegram Stars gift options » as starsGiftOption constructors.
Parameters
Name
Type
Description
flags
#
Flags, see TL conditional fields
user_id
flags.0?InputUser
 
Result
Vector&lt;StarsGiftOption&gt;">
#…">
<meta property="og:title" content="payments.getStarsGiftOptions">
<meta property="og:image" content="">
<meta property="og:description" content="Parameters
<meta property="og:description" content="Obtain a list of Telegram Stars gift options » as starsGiftOption constructors.
Parameters
Name
Type
Description
flags
#
Flags, see TL conditional fields
user_id
flags.0?InputUser
 
Result
Vector&lt;StarsGiftOption&gt;">
#…">
<link rel="icon" type="image/svg+xml" href="/img/website_icon.svg?4">
<link rel="apple-touch-icon" sizes="180x180" href="/img/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/img/favicon-32x32.png">
@ -64,7 +54,8 @@ Vector&lt;StarsGiftOption&gt;">
<div class="dev_page_bread_crumbs"><ul class="breadcrumb clearfix"><li><a href="/api" >API</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/methods" >All Methods</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/method/payments.getStarsGiftOptions" >payments.getStarsGiftOptions</a></li></ul></div>
<h1 id="dev_page_title">payments.getStarsGiftOptions</h1>
<div id="dev_page_content"><p><div class="clearfix">
<div id="dev_page_content"><p>Obtain a list of <a href="/api/stars#buying-stars">Telegram Stars gift options »</a> as <a href="/constructor/starsGiftOption">starsGiftOption</a> constructors.</p>
<p><div class="clearfix">
<ul class="dev_layer_select slightly-pull-right nav nav-pills">
<li class="dropdown">
<a class="dropdown-toggle" onclick="return dropdownClick(this, event)" href="#">Layer 185 <b class="caret"></b></a>
@ -96,7 +87,7 @@ Vector&lt;StarsGiftOption&gt;">
<tr>
<td><strong>user_id</strong></td>
<td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.0?<a href="/type/InputUser">InputUser</a></td>
<td> </td>
<td>Receiver of the gift (optional).</td>
</tr>
</tbody>
</table>

View file

@ -87,7 +87,7 @@
<tr>
<td><strong>ascending</strong></td>
<td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.2?<a href="/constructor/true">true</a></td>
<td> </td>
<td>Return transactions in ascending order by date (instead of descending order by date).</td>
</tr>
<tr>
<td><strong>peer</strong></td>

View file

@ -88,11 +88,11 @@
</tr>
<tr>
<td><a href="/constructor/inputStorePaymentStarsTopup">inputStorePaymentStarsTopup</a></td>
<td>Used to top up the <a href="/api/stars">Telegram Stars balance</a> using the Play Store/App Store flow (official apps only).</td>
<td>Used to top up the <a href="/api/stars">Telegram Stars balance</a> of the current account.</td>
</tr>
<tr>
<td><a href="/constructor/inputStorePaymentStarsGift">inputStorePaymentStarsGift</a></td>
<td>Used to top up the <a href="/api/stars">Telegram Stars</a> balance of a friend using the Play Store/App Store flow (official apps only).</td>
<td>Used to gift <a href="/api/stars">Telegram Stars</a> to a friend.</td>
</tr>
</tbody>
</table></div>