@grom.js/bot-api-spec 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -1,601 +1,3 @@
-//#region src/types.d.ts
-/**
- * Type defined in the API. It can either be an {@link ApiTypeObject object}
- * or a {@link ApiTypeOneOf union}.
- */
-type ApiType = ApiTypeObject | ApiTypeOneOf;
-interface ApiTypeObject {
-  /**
-   * Name of the type.
-   */
-  name: string;
-  /**
-   * Description of the type.
-   */
-  description: Description;
-  /**
-   * Fields of the object representing this type.
-   */
-  fields: Array<FieldOrParam>;
-  oneOf?: never;
-}
-interface ApiTypeOneOf {
-  /**
-   * Name of the type.
-   */
-  name: string;
-  /**
-   * Description of the type.
-   */
-  description: Description;
-  /**
-   * Array of possible types this type can be.
-   */
-  oneOf: Array<ValueTypeApiType>;
-  fields?: never;
-}
-interface ApiMethod {
-  /**
-   * Name of the method.
-   */
-  name: string;
-  /**
-   * Description of the method.
-   */
-  description: Description;
-  /**
-   * Parameters this method takes.
-   */
-  parameters: Array<FieldOrParam>;
-  /**
-   * Type of the value this method returns.
-   */
-  returnType: ValueType;
-}
-interface FieldOrParam {
-  /**
-   * Name of the field/parameter.
-   */
-  name: string;
-  /**
-   * Type of the value this field/parameter can be assigned.
-   */
-  type: ValueType;
-  /**
-   * Whether this is a required field/parameter.
-   */
-  required: boolean;
-  /**
-   * Description of the field/parameter.
-   */
-  description: Description;
-  /**
-   * Whether this field/parameter should be JSON-serialized.
-   */
-  jsonSerialized: boolean;
-}
-/**
- * Description of a type/method/field/parameter.
- */
-interface Description {
-  markdown: string;
-}
-/**
- * Type of a value.
- */
-type ValueType = ValueTypeString | ValueTypeBoolean | ValueTypeInteger32 | ValueTypeInteger53 | ValueTypeFloat | ValueTypeInputFile | ValueTypeApiType | ValueTypeArray | ValueTypeUnion;
-/**
- * `String` value type.
- */
-interface ValueTypeString {
-  type: 'str';
-  literal?: string;
-}
-/**
- * `Boolean` value type.
- */
-interface ValueTypeBoolean {
-  type: 'bool';
-  literal?: boolean;
-}
-/**
- * `Integer` value type, which fits in a 32-bit integer.
- */
-interface ValueTypeInteger32 {
-  type: 'int32';
-  literal?: number;
-}
-/**
- * `Integer` value type, which may have more than 32 significant bits, but has
- * at most 52 significant bits, so a 64-bit integer or double-precision float
- * type are safe for storing values of this type.
- */
-interface ValueTypeInteger53 {
-  type: 'int53';
-}
-/**
- * `Float` value type.
- */
-interface ValueTypeFloat {
-  type: 'float';
-}
-/**
- * [`InputFile`](https://core.telegram.org/bots/api#inputfile) value type.
- */
-interface ValueTypeInputFile {
-  type: 'input-file';
-}
-/**
- * Any {@link ApiType} value type.
- */
-interface ValueTypeApiType {
-  type: 'api-type';
-  name: keyof typeof types;
-}
-/**
- * Array of any value type.
- */
-interface ValueTypeArray {
-  type: 'array';
-  of: ValueType;
-}
-/**
- * Union of any value types.
- */
-interface ValueTypeUnion {
-  type: 'union';
-  types: Array<ValueType>;
-}
-//#endregion
-//#region src/bot-api/methods.gen.d.ts
-/**
- * Definition of all Bot API methods as an object.
- * Properties are created in the same order as they appear in the docs.
- */
-declare const methods: {
-  getUpdates: ApiMethod;
-  setWebhook: ApiMethod;
-  deleteWebhook: ApiMethod;
-  getWebhookInfo: ApiMethod;
-  getMe: ApiMethod;
-  logOut: ApiMethod;
-  close: ApiMethod;
-  sendMessage: ApiMethod;
-  forwardMessage: ApiMethod;
-  forwardMessages: ApiMethod;
-  copyMessage: ApiMethod;
-  copyMessages: ApiMethod;
-  sendPhoto: ApiMethod;
-  sendAudio: ApiMethod;
-  sendDocument: ApiMethod;
-  sendVideo: ApiMethod;
-  sendAnimation: ApiMethod;
-  sendVoice: ApiMethod;
-  sendVideoNote: ApiMethod;
-  sendPaidMedia: ApiMethod;
-  sendMediaGroup: ApiMethod;
-  sendLocation: ApiMethod;
-  sendVenue: ApiMethod;
-  sendContact: ApiMethod;
-  sendPoll: ApiMethod;
-  sendChecklist: ApiMethod;
-  sendDice: ApiMethod;
-  sendChatAction: ApiMethod;
-  setMessageReaction: ApiMethod;
-  getUserProfilePhotos: ApiMethod;
-  setUserEmojiStatus: ApiMethod;
-  getFile: ApiMethod;
-  banChatMember: ApiMethod;
-  unbanChatMember: ApiMethod;
-  restrictChatMember: ApiMethod;
-  promoteChatMember: ApiMethod;
-  setChatAdministratorCustomTitle: ApiMethod;
-  banChatSenderChat: ApiMethod;
-  unbanChatSenderChat: ApiMethod;
-  setChatPermissions: ApiMethod;
-  exportChatInviteLink: ApiMethod;
-  createChatInviteLink: ApiMethod;
-  editChatInviteLink: ApiMethod;
-  createChatSubscriptionInviteLink: ApiMethod;
-  editChatSubscriptionInviteLink: ApiMethod;
-  revokeChatInviteLink: ApiMethod;
-  approveChatJoinRequest: ApiMethod;
-  declineChatJoinRequest: ApiMethod;
-  setChatPhoto: ApiMethod;
-  deleteChatPhoto: ApiMethod;
-  setChatTitle: ApiMethod;
-  setChatDescription: ApiMethod;
-  pinChatMessage: ApiMethod;
-  unpinChatMessage: ApiMethod;
-  unpinAllChatMessages: ApiMethod;
-  leaveChat: ApiMethod;
-  getChat: ApiMethod;
-  getChatAdministrators: ApiMethod;
-  getChatMemberCount: ApiMethod;
-  getChatMember: ApiMethod;
-  setChatStickerSet: ApiMethod;
-  deleteChatStickerSet: ApiMethod;
-  getForumTopicIconStickers: ApiMethod;
-  createForumTopic: ApiMethod;
-  editForumTopic: ApiMethod;
-  closeForumTopic: ApiMethod;
-  reopenForumTopic: ApiMethod;
-  deleteForumTopic: ApiMethod;
-  unpinAllForumTopicMessages: ApiMethod;
-  editGeneralForumTopic: ApiMethod;
-  closeGeneralForumTopic: ApiMethod;
-  reopenGeneralForumTopic: ApiMethod;
-  hideGeneralForumTopic: ApiMethod;
-  unhideGeneralForumTopic: ApiMethod;
-  unpinAllGeneralForumTopicMessages: ApiMethod;
-  answerCallbackQuery: ApiMethod;
-  getUserChatBoosts: ApiMethod;
-  getBusinessConnection: ApiMethod;
-  setMyCommands: ApiMethod;
-  deleteMyCommands: ApiMethod;
-  getMyCommands: ApiMethod;
-  setMyName: ApiMethod;
-  getMyName: ApiMethod;
-  setMyDescription: ApiMethod;
-  getMyDescription: ApiMethod;
-  setMyShortDescription: ApiMethod;
-  getMyShortDescription: ApiMethod;
-  setChatMenuButton: ApiMethod;
-  getChatMenuButton: ApiMethod;
-  setMyDefaultAdministratorRights: ApiMethod;
-  getMyDefaultAdministratorRights: ApiMethod;
-  getAvailableGifts: ApiMethod;
-  sendGift: ApiMethod;
-  giftPremiumSubscription: ApiMethod;
-  verifyUser: ApiMethod;
-  verifyChat: ApiMethod;
-  removeUserVerification: ApiMethod;
-  removeChatVerification: ApiMethod;
-  readBusinessMessage: ApiMethod;
-  deleteBusinessMessages: ApiMethod;
-  setBusinessAccountName: ApiMethod;
-  setBusinessAccountUsername: ApiMethod;
-  setBusinessAccountBio: ApiMethod;
-  setBusinessAccountProfilePhoto: ApiMethod;
-  removeBusinessAccountProfilePhoto: ApiMethod;
-  setBusinessAccountGiftSettings: ApiMethod;
-  getBusinessAccountStarBalance: ApiMethod;
-  transferBusinessAccountStars: ApiMethod;
-  getBusinessAccountGifts: ApiMethod;
-  convertGiftToStars: ApiMethod;
-  upgradeGift: ApiMethod;
-  transferGift: ApiMethod;
-  postStory: ApiMethod;
-  editStory: ApiMethod;
-  deleteStory: ApiMethod;
-  editMessageText: ApiMethod;
-  editMessageCaption: ApiMethod;
-  editMessageMedia: ApiMethod;
-  editMessageLiveLocation: ApiMethod;
-  stopMessageLiveLocation: ApiMethod;
-  editMessageChecklist: ApiMethod;
-  editMessageReplyMarkup: ApiMethod;
-  stopPoll: ApiMethod;
-  approveSuggestedPost: ApiMethod;
-  declineSuggestedPost: ApiMethod;
-  deleteMessage: ApiMethod;
-  deleteMessages: ApiMethod;
-  sendSticker: ApiMethod;
-  getStickerSet: ApiMethod;
-  getCustomEmojiStickers: ApiMethod;
-  uploadStickerFile: ApiMethod;
-  createNewStickerSet: ApiMethod;
-  addStickerToSet: ApiMethod;
-  setStickerPositionInSet: ApiMethod;
-  deleteStickerFromSet: ApiMethod;
-  replaceStickerInSet: ApiMethod;
-  setStickerEmojiList: ApiMethod;
-  setStickerKeywords: ApiMethod;
-  setStickerMaskPosition: ApiMethod;
-  setStickerSetTitle: ApiMethod;
-  setStickerSetThumbnail: ApiMethod;
-  setCustomEmojiStickerSetThumbnail: ApiMethod;
-  deleteStickerSet: ApiMethod;
-  answerInlineQuery: ApiMethod;
-  answerWebAppQuery: ApiMethod;
-  savePreparedInlineMessage: ApiMethod;
-  sendInvoice: ApiMethod;
-  createInvoiceLink: ApiMethod;
-  answerShippingQuery: ApiMethod;
-  answerPreCheckoutQuery: ApiMethod;
-  getMyStarBalance: ApiMethod;
-  getStarTransactions: ApiMethod;
-  refundStarPayment: ApiMethod;
-  editUserStarSubscription: ApiMethod;
-  setPassportDataErrors: ApiMethod;
-  sendGame: ApiMethod;
-  setGameScore: ApiMethod;
-  getGameHighScores: ApiMethod;
-};
-//#endregion
-//#region src/bot-api/types.gen.d.ts
-/**
- * Definition of all Bot API types as an object.
- * Properties are created in the same order as they appear in the docs.
- */
-declare const types: {
-  Update: ApiType;
-  WebhookInfo: ApiType;
-  User: ApiType;
-  Chat: ApiType;
-  ChatFullInfo: ApiType;
-  Message: ApiType;
-  MessageId: ApiType;
-  InaccessibleMessage: ApiType;
-  MaybeInaccessibleMessage: ApiType;
-  MessageEntity: ApiType;
-  TextQuote: ApiType;
-  ExternalReplyInfo: ApiType;
-  ReplyParameters: ApiType;
-  MessageOrigin: ApiType;
-  MessageOriginUser: ApiType;
-  MessageOriginHiddenUser: ApiType;
-  MessageOriginChat: ApiType;
-  MessageOriginChannel: ApiType;
-  PhotoSize: ApiType;
-  Animation: ApiType;
-  Audio: ApiType;
-  Document: ApiType;
-  Story: ApiType;
-  Video: ApiType;
-  VideoNote: ApiType;
-  Voice: ApiType;
-  PaidMediaInfo: ApiType;
-  PaidMedia: ApiType;
-  PaidMediaPreview: ApiType;
-  PaidMediaPhoto: ApiType;
-  PaidMediaVideo: ApiType;
-  Contact: ApiType;
-  Dice: ApiType;
-  PollOption: ApiType;
-  InputPollOption: ApiType;
-  PollAnswer: ApiType;
-  Poll: ApiType;
-  ChecklistTask: ApiType;
-  Checklist: ApiType;
-  InputChecklistTask: ApiType;
-  InputChecklist: ApiType;
-  ChecklistTasksDone: ApiType;
-  ChecklistTasksAdded: ApiType;
-  Location: ApiType;
-  Venue: ApiType;
-  WebAppData: ApiType;
-  ProximityAlertTriggered: ApiType;
-  MessageAutoDeleteTimerChanged: ApiType;
-  ChatBoostAdded: ApiType;
-  BackgroundFill: ApiType;
-  BackgroundFillSolid: ApiType;
-  BackgroundFillGradient: ApiType;
-  BackgroundFillFreeformGradient: ApiType;
-  BackgroundType: ApiType;
-  BackgroundTypeFill: ApiType;
-  BackgroundTypeWallpaper: ApiType;
-  BackgroundTypePattern: ApiType;
-  BackgroundTypeChatTheme: ApiType;
-  ChatBackground: ApiType;
-  ForumTopicCreated: ApiType;
-  ForumTopicClosed: ApiType;
-  ForumTopicEdited: ApiType;
-  ForumTopicReopened: ApiType;
-  GeneralForumTopicHidden: ApiType;
-  GeneralForumTopicUnhidden: ApiType;
-  SharedUser: ApiType;
-  UsersShared: ApiType;
-  ChatShared: ApiType;
-  WriteAccessAllowed: ApiType;
-  VideoChatScheduled: ApiType;
-  VideoChatStarted: ApiType;
-  VideoChatEnded: ApiType;
-  VideoChatParticipantsInvited: ApiType;
-  PaidMessagePriceChanged: ApiType;
-  DirectMessagePriceChanged: ApiType;
-  SuggestedPostApproved: ApiType;
-  SuggestedPostApprovalFailed: ApiType;
-  SuggestedPostDeclined: ApiType;
-  SuggestedPostPaid: ApiType;
-  SuggestedPostRefunded: ApiType;
-  GiveawayCreated: ApiType;
-  Giveaway: ApiType;
-  GiveawayWinners: ApiType;
-  GiveawayCompleted: ApiType;
-  LinkPreviewOptions: ApiType;
-  SuggestedPostPrice: ApiType;
-  SuggestedPostInfo: ApiType;
-  SuggestedPostParameters: ApiType;
-  DirectMessagesTopic: ApiType;
-  UserProfilePhotos: ApiType;
-  File: ApiType;
-  WebAppInfo: ApiType;
-  ReplyKeyboardMarkup: ApiType;
-  KeyboardButton: ApiType;
-  KeyboardButtonRequestUsers: ApiType;
-  KeyboardButtonRequestChat: ApiType;
-  KeyboardButtonPollType: ApiType;
-  ReplyKeyboardRemove: ApiType;
-  InlineKeyboardMarkup: ApiType;
-  InlineKeyboardButton: ApiType;
-  LoginUrl: ApiType;
-  SwitchInlineQueryChosenChat: ApiType;
-  CopyTextButton: ApiType;
-  CallbackQuery: ApiType;
-  ForceReply: ApiType;
-  ChatPhoto: ApiType;
-  ChatInviteLink: ApiType;
-  ChatAdministratorRights: ApiType;
-  ChatMemberUpdated: ApiType;
-  ChatMember: ApiType;
-  ChatMemberOwner: ApiType;
-  ChatMemberAdministrator: ApiType;
-  ChatMemberMember: ApiType;
-  ChatMemberRestricted: ApiType;
-  ChatMemberLeft: ApiType;
-  ChatMemberBanned: ApiType;
-  ChatJoinRequest: ApiType;
-  ChatPermissions: ApiType;
-  Birthdate: ApiType;
-  BusinessIntro: ApiType;
-  BusinessLocation: ApiType;
-  BusinessOpeningHoursInterval: ApiType;
-  BusinessOpeningHours: ApiType;
-  StoryAreaPosition: ApiType;
-  LocationAddress: ApiType;
-  StoryAreaType: ApiType;
-  StoryAreaTypeLocation: ApiType;
-  StoryAreaTypeSuggestedReaction: ApiType;
-  StoryAreaTypeLink: ApiType;
-  StoryAreaTypeWeather: ApiType;
-  StoryAreaTypeUniqueGift: ApiType;
-  StoryArea: ApiType;
-  ChatLocation: ApiType;
-  ReactionType: ApiType;
-  ReactionTypeEmoji: ApiType;
-  ReactionTypeCustomEmoji: ApiType;
-  ReactionTypePaid: ApiType;
-  ReactionCount: ApiType;
-  MessageReactionUpdated: ApiType;
-  MessageReactionCountUpdated: ApiType;
-  ForumTopic: ApiType;
-  Gift: ApiType;
-  Gifts: ApiType;
-  UniqueGiftModel: ApiType;
-  UniqueGiftSymbol: ApiType;
-  UniqueGiftBackdropColors: ApiType;
-  UniqueGiftBackdrop: ApiType;
-  UniqueGift: ApiType;
-  GiftInfo: ApiType;
-  UniqueGiftInfo: ApiType;
-  OwnedGift: ApiType;
-  OwnedGiftRegular: ApiType;
-  OwnedGiftUnique: ApiType;
-  OwnedGifts: ApiType;
-  AcceptedGiftTypes: ApiType;
-  StarAmount: ApiType;
-  BotCommand: ApiType;
-  BotCommandScope: ApiType;
-  BotCommandScopeDefault: ApiType;
-  BotCommandScopeAllPrivateChats: ApiType;
-  BotCommandScopeAllGroupChats: ApiType;
-  BotCommandScopeAllChatAdministrators: ApiType;
-  BotCommandScopeChat: ApiType;
-  BotCommandScopeChatAdministrators: ApiType;
-  BotCommandScopeChatMember: ApiType;
-  BotName: ApiType;
-  BotDescription: ApiType;
-  BotShortDescription: ApiType;
-  MenuButton: ApiType;
-  MenuButtonCommands: ApiType;
-  MenuButtonWebApp: ApiType;
-  MenuButtonDefault: ApiType;
-  ChatBoostSource: ApiType;
-  ChatBoostSourcePremium: ApiType;
-  ChatBoostSourceGiftCode: ApiType;
-  ChatBoostSourceGiveaway: ApiType;
-  ChatBoost: ApiType;
-  ChatBoostUpdated: ApiType;
-  ChatBoostRemoved: ApiType;
-  UserChatBoosts: ApiType;
-  BusinessBotRights: ApiType;
-  BusinessConnection: ApiType;
-  BusinessMessagesDeleted: ApiType;
-  ResponseParameters: ApiType;
-  InputMedia: ApiType;
-  InputMediaPhoto: ApiType;
-  InputMediaVideo: ApiType;
-  InputMediaAnimation: ApiType;
-  InputMediaAudio: ApiType;
-  InputMediaDocument: ApiType;
-  InputPaidMedia: ApiType;
-  InputPaidMediaPhoto: ApiType;
-  InputPaidMediaVideo: ApiType;
-  InputProfilePhoto: ApiType;
-  InputProfilePhotoStatic: ApiType;
-  InputProfilePhotoAnimated: ApiType;
-  InputStoryContent: ApiType;
-  InputStoryContentPhoto: ApiType;
-  InputStoryContentVideo: ApiType;
-  Sticker: ApiType;
-  StickerSet: ApiType;
-  MaskPosition: ApiType;
-  InputSticker: ApiType;
-  InlineQuery: ApiType;
-  InlineQueryResultsButton: ApiType;
-  InlineQueryResult: ApiType;
-  InlineQueryResultArticle: ApiType;
-  InlineQueryResultPhoto: ApiType;
-  InlineQueryResultGif: ApiType;
-  InlineQueryResultMpeg4Gif: ApiType;
-  InlineQueryResultVideo: ApiType;
-  InlineQueryResultAudio: ApiType;
-  InlineQueryResultVoice: ApiType;
-  InlineQueryResultDocument: ApiType;
-  InlineQueryResultLocation: ApiType;
-  InlineQueryResultVenue: ApiType;
-  InlineQueryResultContact: ApiType;
-  InlineQueryResultGame: ApiType;
-  InlineQueryResultCachedPhoto: ApiType;
-  InlineQueryResultCachedGif: ApiType;
-  InlineQueryResultCachedMpeg4Gif: ApiType;
-  InlineQueryResultCachedSticker: ApiType;
-  InlineQueryResultCachedDocument: ApiType;
-  InlineQueryResultCachedVideo: ApiType;
-  InlineQueryResultCachedVoice: ApiType;
-  InlineQueryResultCachedAudio: ApiType;
-  InputMessageContent: ApiType;
-  InputTextMessageContent: ApiType;
-  InputLocationMessageContent: ApiType;
-  InputVenueMessageContent: ApiType;
-  InputContactMessageContent: ApiType;
-  InputInvoiceMessageContent: ApiType;
-  ChosenInlineResult: ApiType;
-  SentWebAppMessage: ApiType;
-  PreparedInlineMessage: ApiType;
-  LabeledPrice: ApiType;
-  Invoice: ApiType;
-  ShippingAddress: ApiType;
-  OrderInfo: ApiType;
-  ShippingOption: ApiType;
-  SuccessfulPayment: ApiType;
-  RefundedPayment: ApiType;
-  ShippingQuery: ApiType;
-  PreCheckoutQuery: ApiType;
-  PaidMediaPurchased: ApiType;
-  RevenueWithdrawalState: ApiType;
-  RevenueWithdrawalStatePending: ApiType;
-  RevenueWithdrawalStateSucceeded: ApiType;
-  RevenueWithdrawalStateFailed: ApiType;
-  AffiliateInfo: ApiType;
-  TransactionPartner: ApiType;
-  TransactionPartnerUser: ApiType;
-  TransactionPartnerChat: ApiType;
-  TransactionPartnerAffiliateProgram: ApiType;
-  TransactionPartnerFragment: ApiType;
-  TransactionPartnerTelegramAds: ApiType;
-  TransactionPartnerTelegramApi: ApiType;
-  TransactionPartnerOther: ApiType;
-  StarTransaction: ApiType;
-  StarTransactions: ApiType;
-  PassportData: ApiType;
-  PassportFile: ApiType;
-  EncryptedPassportElement: ApiType;
-  EncryptedCredentials: ApiType;
-  PassportElementError: ApiType;
-  PassportElementErrorDataField: ApiType;
-  PassportElementErrorFrontSide: ApiType;
-  PassportElementErrorReverseSide: ApiType;
-  PassportElementErrorSelfie: ApiType;
-  PassportElementErrorFile: ApiType;
-  PassportElementErrorFiles: ApiType;
-  PassportElementErrorTranslationFile: ApiType;
-  PassportElementErrorTranslationFiles: ApiType;
-  PassportElementErrorUnspecified: ApiType;
-  Game: ApiType;
-  CallbackGame: ApiType;
-  GameHighScore: ApiType;
-};
-//#endregion
-export { ApiMethod, ApiType, ApiTypeObject, ApiTypeOneOf, Description, FieldOrParam, ValueType, ValueTypeApiType, ValueTypeArray, ValueTypeBoolean, ValueTypeFloat, ValueTypeInputFile, ValueTypeInteger32, ValueTypeInteger53, ValueTypeString, ValueTypeUnion, methods, types };
+export { methods } from './methods.gen.ts';
+export { types } from './types.gen.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA"}