@grammyjs/types 3.16.0 → 3.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grammyjs/types",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Telegram Bot API type declarations for grammY",
   "main": "mod.js",
   "repository": {

package/payment.d.ts

@@ -1,4 +1,4 @@
-import type { User } from "./manage.js";
+import type { Chat, User } from "./manage.js";
 import type { PaidMedia, Sticker } from "./message.js";
 /** This object represents a portion of the price for goods or services. */
 export interface LabeledPrice {
@@ -144,20 +144,36 @@ export interface RevenueWithdrawalStateFailed {
     /** Type of the state, always “failed” */
     type: "failed";
 }
+/** Contains information about the affiliate that received a commission via this transaction. */
+export interface AffiliateInfo {
+    /** The bot or the user that received an affiliate commission if it was received by a bot or a user */
+    affiliate_user?: User;
+    /** The chat that received an affiliate commission if it was received by a chat */
+    affiliate_chat?: Chat;
+    /** The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users */
+    commission_per_mille: number;
+    /** Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds */
+    amount: number;
+    /** The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds */
+    nanostar_amount?: number;
+}
 /** This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
 
 - TransactionPartnerUser
+- TransactionPartnerAffiliateProgram
 - TransactionPartnerFragment
 - TransactionPartnerTelegramAds
 - TransactionPartnerTelegramApi
 - TransactionPartnerOther */
-export type TransactionPartner = TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerTelegramApi | TransactionPartnerOther;
+export type TransactionPartner = TransactionPartnerUser | TransactionPartnerAffiliateProgram | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerTelegramApi | TransactionPartnerOther;
 /** Describes a transaction with a user. */
 export interface TransactionPartnerUser {
     /** Type of the transaction partner, always “user” */
     type: "user";
     /** Information about the user */
     user: User;
+    /** Information about the affiliate that received a commission via this transaction */
+    affiliate?: AffiliateInfo;
     /** Bot-specified invoice payload */
     invoice_payload?: string;
     /** The duration of the paid subscription */
@@ -169,6 +185,15 @@ export interface TransactionPartnerUser {
     /** The gift sent to the user by the bot */
     gift?: string;
 }
+/** Describes the affiliate program that issued the affiliate commission received via this transaction. */
+export interface TransactionPartnerAffiliateProgram {
+    /** Type of the transaction partner, always “affiliate_program” */
+    type: "affiliate_program";
+    /** Information about the bot that sponsored the affiliate program */
+    sponsor_user?: User;
+    /** The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users */
+    commission_per_mille: number;
+}
 /** Describes a withdrawal transaction with Fragment. */
 export interface TransactionPartnerFragment {
     /** Type of the transaction partner, always “fragment” */
@@ -197,8 +222,10 @@ export interface TransactionPartnerOther {
 export interface StarTransaction {
     /** Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users. */
     id: string;
-    /** Number of Telegram Stars transferred by the transaction */
+    /** Integer amount of Telegram Stars transferred by the transaction */
     amount: number;
+    /** The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999 */
+    nanostar_amount?: number;
     /** Date the transaction was created in Unix time */
     date: number;
     /** Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions */