Class TransactionPartner

Hierarchy (view full)

Base
- TransactionPartner

Index

Constructors

constructor

new TransactionPartner(client, data): TransactionPartner
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: TransactionPartner
  Data about the describes the source of a transaction, or its recipient for outgoing transactions
Returns TransactionPartner
Overrides Base.constructor

Properties

`Optional`gift

gift?: string

The gift sent to the user by the bot.

`Optional`paidMedia

paidMedia?: PaidMedia[]

Information about the paid media bought by the user

`Optional`paidMediaPayload

paidMediaPayload?: string

Bot-specified paid media payload

`Optional`payload

payload?: string

Bot-specified invoice payload

`Optional`requestCount

requestCount?: number

The number of successful requests that exceeded regular limits and were therefore billed

`Optional`subscriptionPeriod

subscriptionPeriod?: number

The duration of the paid subscription.

type

Type of the transaction partner

`Optional`user

user?: User

Information about the user

`Optional`withdrawal

withdrawal?: RevenueWithdrawalState

State of the transaction if the transaction is outgoing

Accessors

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from Base.client

Methods

`Protected`_clone

_clone(): Base
Protected
Creates a clone of the current instance

Returns Base
A clone of the current instance

Inherited from Base._clone

_patch

_patch(data): TransactionPartner
Parameters
- data: TransactionPartner
  Data about the describes the source of a transaction, or its recipient for outgoing transactions
Returns TransactionPartner
Overrides Base._patch

`Protected`_update

_update(data): Base
Protected
Updates the current instance with new data and returns a clone of the updated instance
Parameters
- data: Record<string, any>
  The data to update the instance with
Returns Base
A clone of the updated instance

Inherited from Base._update

isFragment

isFragment(): this is TransactionPartner & {
    gift?: undefined;
    paidMedia?: undefined;
    paidMediaPayload?: undefined;
    requestCount?: undefined;
    subscriptionPeriod?: undefined;
    user?: undefined;
    withdrawal: RevenueWithdrawalState;
}
Returns this is TransactionPartner & {
    gift?: undefined;
    paidMedia?: undefined;
    paidMediaPayload?: undefined;
    requestCount?: undefined;
    subscriptionPeriod?: undefined;
    user?: undefined;
    withdrawal: RevenueWithdrawalState;
}

isTelegramApi

isTelegramApi(): this is TransactionPartner & {
    gift?: undefined;
    paidMedia?: undefined;
    paidMediaPayload?: undefined;
    requestCount: number;
    subscriptionPeriod?: undefined;
    user?: undefined;
    withdrawal?: undefined;
}
Returns this is TransactionPartner & {
    gift?: undefined;
    paidMedia?: undefined;
    paidMediaPayload?: undefined;
    requestCount: number;
    subscriptionPeriod?: undefined;
    user?: undefined;
    withdrawal?: undefined;
}

isUser

isUser(): this is TransactionPartner & {
    gift?: string;
    paidMedia?: PaidMedia[];
    paidMediaPayload?: string;
    requestCount?: undefined;
    subscriptionPeriod?: number;
    user: User;
    withdrawal?: undefined;
}
Returns this is TransactionPartner & {
    gift?: string;
    paidMedia?: PaidMedia[];
    paidMediaPayload?: string;
    requestCount?: undefined;
    subscriptionPeriod?: number;
    user: User;
    withdrawal?: undefined;
}

toJSON

toJSON(propsRecursive?, ...props): Record<string, any>
Flatten an object. Any properties that are collections will get converted to an array of keys.
Parameters
- OptionalpropsRecursive: boolean
  Optional. If true, calls toJSON method on nested objects.
- Rest...props: Record<string, string | boolean>[]
  Optional. Specific properties to include/exclude, or rename.
Returns Record<string, any>
Flattened object.

Inherited from Base.toJSON

valueOf

valueOf(): null | string
Returns the id instance Chat, User, ChatMember and other

Returns null | string
Inherited from Base.valueOf

Class TransactionPartner

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TransactionPartner

Properties

Optionalgift

OptionalpaidMedia

OptionalpaidMediaPayload

Optionalpayload

OptionalrequestCount

OptionalsubscriptionPeriod

type

Optionaluser

Optionalwithdrawal

Accessors

client

Returns TelegramClient

Methods

Protected_clone

Returns Base

_patch

Parameters

Returns TransactionPartner

Protected_update

Parameters

Returns Base

isFragment

Returns this is TransactionPartner & { gift?: undefined; paidMedia?: undefined; paidMediaPayload?: undefined; requestCount?: undefined; subscriptionPeriod?: undefined; user?: undefined; withdrawal: RevenueWithdrawalState; }

isTelegramApi

Returns this is TransactionPartner & { gift?: undefined; paidMedia?: undefined; paidMediaPayload?: undefined; requestCount: number; subscriptionPeriod?: undefined; user?: undefined; withdrawal?: undefined; }

isUser

Returns this is TransactionPartner & { gift?: string; paidMedia?: PaidMedia[]; paidMediaPayload?: string; requestCount?: undefined; subscriptionPeriod?: number; user: User; withdrawal?: undefined; }

toJSON

Parameters

Returns Record<string, any>

valueOf

Returns null | string

Settings

On This Page

`Optional`gift

`Optional`paidMedia

`Optional`paidMediaPayload

`Optional`payload

`Optional`requestCount

`Optional`subscriptionPeriod

`Optional`user

`Optional`withdrawal

`Protected`_clone

`Protected`_update

Returns this is TransactionPartner & {
gift?: undefined;
paidMedia?: undefined;
paidMediaPayload?: undefined;
requestCount?: undefined;
subscriptionPeriod?: undefined;
user?: undefined;
withdrawal: RevenueWithdrawalState;
}

Returns this is TransactionPartner & {
gift?: undefined;
paidMedia?: undefined;
paidMediaPayload?: undefined;
requestCount: number;
subscriptionPeriod?: undefined;
user?: undefined;
withdrawal?: undefined;
}

Returns this is TransactionPartner & {
gift?: string;
paidMedia?: PaidMedia[];
paidMediaPayload?: string;
requestCount?: undefined;
subscriptionPeriod?: number;
user: User;
withdrawal?: undefined;
}