typescript-telegram-bot-api
Version:
Telegram Bot API wrapper for Node.js written in TypeScript
56 lines (55 loc) • 1.64 kB
TypeScript
import { User } from './';
/**
* ## ChatInviteLink
* Represents an invite link for a chat.
* @see https://core.telegram.org/bots/api#chatinvitelink
*/
export type ChatInviteLink = {
/**
* The invite link. If the link was created by another chat administrator, then the second part of the link will be
* replaced with “…”.
*/
invite_link: string;
/**
* Creator of the link
*/
creator: User;
/**
* True, if users joining the chat via the link need to be approved by chat administrators
*/
creates_join_request: boolean;
/**
* True, if the link is primary
*/
is_primary: boolean;
/**
* True, if the link is revoked
*/
is_revoked: boolean;
/**
* Optional. Invite link name
*/
name?: string;
/**
* Optional. Point in time (Unix timestamp) when the link will expire or has been expired
*/
expire_date?: number;
/**
* Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via
* this invite link; 1-99999
*/
member_limit?: number;
/**
* Optional. Number of pending join requests created using this link
*/
pending_join_request_count?: number;
/**
* Optional. The number of seconds the subscription will be active for before the next payment
*/
subscription_period?: number;
/**
* Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to
* be a member of the chat using the link
*/
subscription_price?: number;
};