Skip to content

Commit

Permalink
[Build]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 14, 2025
1 parent e3f46bf commit 0fb5579
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 1 deletion.
1 change: 1 addition & 0 deletions _versions.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export default [
"0.16.0",
"0.15.1",
"0.15.0",
"0.14.0",
Expand Down
1 change: 1 addition & 0 deletions doc/https:[email protected]

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions src/methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,14 @@ Get available gifts.
Get gifts claimed by a specific user. User-only.


</div></div>
<div class="descr-list-border"></div>
<a href="/methods/sendgift">sendGift</a>
<div><div>

Send a gift.


</div></div>
<div class="descr-list-border"></div>

Expand Down
6 changes: 5 additions & 1 deletion src/methods/getusergifts.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ Get gifts claimed by a specific user. User-only.

### Parameters

<div class="flex flex-col gap-3"><div><div class="font-mono" id="p_userId" data-anchor><span class="font-bold">userId</span><span class="opacity-50">:</span> <a href="/types/id" >ID</a></div></div><div class="flex flex-col gap-3"><div><div class="flex gap-2"><div class="font-mono p" id="p_offset" data-anchor><span class="font-bold">offset</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin">
<div class="flex flex-col gap-3"><div><div class="font-mono" id="p_userId" data-anchor><span class="font-bold">userId</span><span class="opacity-50">:</span> <a href="/types/id" >ID</a></div><div class="pl-3"><div class="no-margin">

The identifier of the user to get gifts for.

</div></div></div><div class="flex flex-col gap-3"><div><div class="flex gap-2"><div class="font-mono p" id="p_offset" data-anchor><span class="font-bold">offset</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin">

An offset key returned by a previous result.

Expand Down
62 changes: 62 additions & 0 deletions src/methods/sendgift.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: sendGift
---

Send a gift.


### Parameters

<div class="flex flex-col gap-3"><div><div class="font-mono" id="p_userId" data-anchor><span class="font-bold">userId</span><span class="opacity-50">:</span> <a href="/types/id" >ID</a></div><div class="pl-3"><div class="no-margin">

The identifier of user to send the gift to.

</div></div></div><div><div class="font-mono" id="p_giftId" data-anchor><span class="font-bold">giftId</span><span class="opacity-50">:</span> <span>string</span></div><div class="pl-3"><div class="no-margin">

The identifier of the gift to send.

</div></div></div><div class="flex flex-col gap-3"><div><div class="flex gap-2"><div class="font-mono p" id="p_message" data-anchor><span class="font-bold">message</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin">

A message to send along with the gift.

</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_parseMode" data-anchor><span class="font-bold">parseMode</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <a href="/types/parsemode" >ParseMode</a></div></div><div class="pl-3"><div class="no-margin">

The parse mode to use for the message.

</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_entities" data-anchor><span class="font-bold">entities</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <a href="/types/messageentity" >MessageEntity</a><span class="opacity-50">[]</span></div></div><div class="pl-3"><div class="no-margin">

The entities of the message.

</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_private" data-anchor><span class="font-bold">private</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>boolean</span></div></div><div class="pl-3"><div class="no-margin">

If true, only the receiver of the gift will know the name of the sender.

</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_upgrade" data-anchor><span class="font-bold">upgrade</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>boolean</span></div></div><div class="pl-3"><div class="no-margin">

Whether the gift should be upgraded before sending it.

</div></div></div></div></div>

### Result

<div class="font-mono"><span>void</span></div>

### Syntax

```ts
// Required parameters only.
await client.sendGift(userId, giftId);

// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.sendGift(userId, giftId, {
message,
parseMode,
entities,
private,
upgrade,
});
```



0 comments on commit 0fb5579

Please sign in to comment.