{
"id": 2495,
"name": "InvoiceSendOptions",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
"id": 2520,
"name": "allowSendingWithoutReply",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true* if the message should be sent even if the specified replied-to message is not found"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1380,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2500,
"name": "currency",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Three-letter ISO 4217 currency code"
}
],
"blockTags": [
{
"tag": "@see",
"content": [
{
"kind": "text",
"text": "https://core.telegram.org/bots/payments#supported-currencies"
}
]
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1319,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2497,
"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": 1307,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2517,
"name": "disableNotification",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages).\nUsers will receive a notification with no sound."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1374,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2516,
"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": 1369,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2502,
"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 (integer, **not** float). For example, for a maximum tip of "
},
{
"kind": "code",
"text": "`US$ 1.45`"
},
{
"kind": "text",
"text": " pass "
},
{
"kind": "code",
"text": "`maxTipAmount: 145`"
},
{
"kind": "text",
"text": ". See the *exp* parameter in [currencieson](https://core.telegram.org/bots/payments/currencieson), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1326,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2512,
"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": 1361,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2510,
"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": 1357,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2511,
"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": 1359,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2513,
"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": 1363,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2498,
"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": 1312,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2509,
"name": "photoHeight",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Photo height"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1355,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2507,
"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": 1351,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2506,
"name": "photoUrl",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.\nPeople like it better when they see what they are paying for."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1349,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2508,
"name": "photoWidth",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Photo width"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1353,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2501,
"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": 1324,
"character": 1
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": 2550,
"name": "LabeledPrice",
"package": "tgkit"
}
}
},
{
"id": 2518,
"name": "protectContent",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Protects the contents of the sent message from forwarding and saving"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1376,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2505,
"name": "providerData",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "JSON-serialized data about the invoice, which will be shared with the payment provider.\nA detailed description of required fields should be provided by the payment provider."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1344,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2499,
"name": "providerToken",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Payments provider token, obtained via [@BotFather](https://t.me/botfather)"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1314,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2521,
"name": "replyMarkup",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "An object for an\n[inline keyboard](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating).\nIf empty, one 'Pay "
},
{
"kind": "code",
"text": "`total price`"
},
{
"kind": "text",
"text": "' button will be shown. If not empty, the first button must be a Pay button."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1386,
"character": 1
}
],
"type": {
"type": "reference",
"target": 1379,
"name": "InlineKeyboardMarkup",
"package": "tgkit",
"qualifiedName": "default"
}
},
{
"id": 2519,
"name": "replyToMessageId",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "If the message is a reply, ID of the original message"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1378,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2515,
"name": "sendEmailToProvider",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if user's email address should be sent to provider"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1367,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2514,
"name": "sendPhoneNumberToProvider",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if user's phone number should be sent to provider"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1365,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2504,
"name": "startParameter",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a *Pay* button,\nallowing multiple users to pay directly from the forwarded message, using the same invoice.\nIf non-empty, forwarded copies of the sent message will have a *URL* button with a deep link to the bot\n(instead of a *Pay* button), with the value used as the start parameter"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1339,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2503,
"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 (integer, **not** float).\nAt most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive,\npassed in a strictly increased order and must not exceed *maxTipAmount*."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1332,
"character": 1
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "number"
}
}
},
{
"id": 2496,
"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": 1305,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [
2520,
2500,
2497,
2517,
2516,
2502,
2512,
2510,
2511,
2513,
2498,
2509,
2507,
2506,
2508,
2501,
2518,
2505,
2499,
2521,
2519,
2515,
2514,
2504,
2503,
2496
]
}
],
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1303,
"character": 17
}
]
}