{
"id": 2761,
"name": "InputInvoiceMessageContent",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
"id": 2766,
"name": "currency",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Three-letter ISO 4217 currency code"
}
],
"blockTags": [
{
"tag": "@see",
"content": [
{
"kind": "inline-tag",
"tag": "@link",
"text": "https://core.telegram.org/bots/payments#supported-currencies",
"target": "https://core.telegram.org/bots/payments#supported-currencies"
}
]
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2147,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2763,
"name": "description",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Product description, 1-255 characters"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2135,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2781,
"name": "isFlexible",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true* if the final price depends on the shipping method"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2195,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2768,
"name": "maxTipAmount",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The maximum accepted amount for tips in the *smallest units* of the currency.\nFor example, for a maximum tip of US$ 1.45 pass "
},
{
"kind": "code",
"text": "`maxTipAmount: 145`"
},
{
"kind": "text",
"text": ".\nDefaults to 0."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2158,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2777,
"name": "needEmail",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true* if you require the user's email address to complete the order"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2187,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2775,
"name": "needName",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true* if you require the user's full name to complete the order"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2183,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2776,
"name": "needPhoneNumber",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true* if you require the user's phone number to complete the order"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2185,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2778,
"name": "needShippingAddress",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true* if you require the user's shipping address to complete the order"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2189,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2764,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Bot-defined invoice payload, 1-128 bytes.\nThis will not be displayed to the user, use for your internal processes."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2140,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2774,
"name": "photoHeight",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Photo height"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2181,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2772,
"name": "photoSize",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Photo size in bytes"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2177,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2771,
"name": "photoUrl",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "URL of the product photo for the invoice.\nCan be a photo of the goods or a marketing image for a service."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2175,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2773,
"name": "photoWidth",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Photo width"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2179,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2767,
"name": "prices",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Price breakdown, a list of components \n(e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2152,
"character": 1
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": 2550,
"name": "LabeledPrice",
"package": "tgkit"
}
}
},
{
"id": 2770,
"name": "providerData",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "A JSON-serialized object for data about the invoice, which will be shared with the payment provider.\nA detailed description of the required fields should be provided by the payment provider."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2170,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2765,
"name": "providerToken",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Payment provider token, obtained via [@BotFather](https://t.me/BotFather)"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2142,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2780,
"name": "sendEmailToProvider",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true* if the user's email address should be sent to provider"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2193,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2779,
"name": "sendPhoneNumberToProvider",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true* if the user's phone number should be sent to provider"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2191,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2769,
"name": "suggestedTipAmounts",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "An array of suggested amounts of tip in the smallest units of the currency.\nAt most 4 suggested tip amounts can be specified.\nThe suggested tip amounts must be positive,\npassed in a strictly increased orderandmust not exceed *max_tip_amount*."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2165,
"character": 1
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "number"
}
}
},
{
"id": 2762,
"name": "title",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Product name, 1-32 characters"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2133,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [
2766,
2763,
2781,
2768,
2777,
2775,
2776,
2778,
2764,
2774,
2772,
2771,
2773,
2767,
2770,
2765,
2780,
2779,
2769,
2762
]
}
],
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 2131,
"character": 17
}
]
}