UNPKG

vk-io

Version:

Modern VK API SDK for Node.js

1,098 lines 93.9 kB
import * as Params from "./params"; import * as Responses from "./responses"; /** * The API account group */ export interface APIAccount { ban(params: Params.AccountBanParams): Promise<Responses.BaseOkResponse>; /** * Changes a user password after access is successfully restored with the [vk.com/dev/auth.restore|auth.restore] method. */ changePassword(params: Params.AccountChangePasswordParams): Promise<Responses.AccountChangePasswordResponse>; /** * Returns a list of active ads (offers) which executed by the user will bring him/her respective number of votes to his balance in the application. */ getActiveOffers(params: Params.AccountGetActiveOffersParams): Promise<Responses.AccountGetActiveOffersResponse>; /** * Gets settings of the user in this application. */ getAppPermissions(params: Params.AccountGetAppPermissionsParams): Promise<Responses.AccountGetAppPermissionsResponse>; /** * Returns a user's blacklist. */ getBanned(params: Params.AccountGetBannedParams): Promise<Responses.AccountGetBannedResponse>; /** * Returns non-null values of user counters. */ getCounters(params: Params.AccountGetCountersParams): Promise<Responses.AccountGetCountersResponse>; /** * Returns current account info. */ getInfo(params: Params.AccountGetInfoParams): Promise<Responses.AccountGetInfoResponse>; /** * Returns the current account info. */ getProfileInfo(params: Params.AccountGetProfileInfoParams): Promise<Responses.AccountGetProfileInfoResponse>; /** * Gets settings of push notifications. */ getPushSettings(params: Params.AccountGetPushSettingsParams): Promise<Responses.AccountGetPushSettingsResponse>; /** * Subscribes an iOS/Android/Windows Phone-based device to receive push notifications */ registerDevice(params: Params.AccountRegisterDeviceParams): Promise<Responses.BaseOkResponse>; /** * Edits current profile info. */ saveProfileInfo(params: Params.AccountSaveProfileInfoParams): Promise<Responses.AccountSaveProfileInfoResponse>; /** * Allows to edit the current account info. */ setInfo(params: Params.AccountSetInfoParams): Promise<Responses.BaseOkResponse>; /** * Marks a current user as offline. */ setOffline(params: Params.AccountSetOfflineParams): Promise<Responses.BaseOkResponse>; /** * Marks the current user as online for 15 minutes. */ setOnline(params: Params.AccountSetOnlineParams): Promise<Responses.BaseOkResponse>; /** * Change push settings. */ setPushSettings(params: Params.AccountSetPushSettingsParams): Promise<Responses.BaseOkResponse>; /** * Mutes push notifications for the set period of time. */ setSilenceMode(params: Params.AccountSetSilenceModeParams): Promise<Responses.BaseOkResponse>; unban(params: Params.AccountUnbanParams): Promise<Responses.BaseOkResponse>; /** * Unsubscribes a device from push notifications. */ unregisterDevice(params: Params.AccountUnregisterDeviceParams): Promise<Responses.BaseOkResponse>; } /** * The API ads group */ export interface APIAds { /** * Adds managers and/or supervisors to advertising account. */ addOfficeUsers(params: Params.AdsAddOfficeUsersParams): Promise<Responses.AdsAddOfficeUsersResponse>; /** * Allows to check the ad link. */ checkLink(params: Params.AdsCheckLinkParams): Promise<Responses.AdsCheckLinkResponse>; /** * Creates ads. */ createAds(params: Params.AdsCreateAdsParams): Promise<Responses.AdsCreateAdsResponse>; /** * Creates advertising campaigns. */ createCampaigns(params: Params.AdsCreateCampaignsParams): Promise<Responses.AdsCreateCampaignsResponse>; /** * Creates clients of an advertising agency. */ createClients(params: Params.AdsCreateClientsParams): Promise<Responses.AdsCreateClientsResponse>; createLookalikeRequest(params: Params.AdsCreateLookalikeRequestParams): Promise<Responses.AdsCreateLookalikeRequestResponse>; /** * Creates a group to re-target ads for users who visited advertiser's site (viewed information about the product, registered, etc.). */ createTargetGroup(params: Params.AdsCreateTargetGroupParams): Promise<Responses.AdsCreateTargetGroupResponse>; createTargetPixel(params: Params.AdsCreateTargetPixelParams): Promise<Responses.AdsCreateTargetPixelResponse>; /** * Archives ads. */ deleteAds(params: Params.AdsDeleteAdsParams): Promise<Responses.AdsDeleteAdsResponse>; /** * Archives advertising campaigns. */ deleteCampaigns(params: Params.AdsDeleteCampaignsParams): Promise<Responses.AdsDeleteCampaignsResponse>; /** * Archives clients of an advertising agency. */ deleteClients(params: Params.AdsDeleteClientsParams): Promise<Responses.AdsDeleteClientsResponse>; /** * Deletes a retarget group. */ deleteTargetGroup(params: Params.AdsDeleteTargetGroupParams): Promise<Responses.BaseOkResponse>; deleteTargetPixel(params: Params.AdsDeleteTargetPixelParams): Promise<Responses.BaseUndefinedResponse>; /** * Returns a list of advertising accounts. */ getAccounts(params: Params.AdsGetAccountsParams): Promise<Responses.AdsGetAccountsResponse>; /** * Returns number of ads. */ getAds(params: Params.AdsGetAdsParams): Promise<Responses.AdsGetAdsResponse>; /** * Returns descriptions of ad layouts. */ getAdsLayout(params: Params.AdsGetAdsLayoutParams): Promise<Responses.AdsGetAdsLayoutResponse>; /** * Returns ad targeting parameters. */ getAdsTargeting(params: Params.AdsGetAdsTargetingParams): Promise<Responses.AdsGetAdsTargetingResponse>; /** * Returns current budget of the advertising account. */ getBudget(params: Params.AdsGetBudgetParams): Promise<Responses.AdsGetBudgetResponse>; /** * Returns a list of campaigns in an advertising account. */ getCampaigns(params: Params.AdsGetCampaignsParams): Promise<Responses.AdsGetCampaignsResponse>; /** * Returns a list of possible ad categories. */ getCategories(params: Params.AdsGetCategoriesParams): Promise<Responses.AdsGetCategoriesResponse>; /** * Returns a list of advertising agency's clients. */ getClients(params: Params.AdsGetClientsParams): Promise<Responses.AdsGetClientsResponse>; /** * Returns demographics for ads or campaigns. */ getDemographics(params: Params.AdsGetDemographicsParams): Promise<Responses.AdsGetDemographicsResponse>; /** * Returns information about current state of a counter - number of remaining runs of methods and time to the next counter nulling in seconds. */ getFloodStats(params: Params.AdsGetFloodStatsParams): Promise<Responses.AdsGetFloodStatsResponse>; getLookalikeRequests(params: Params.AdsGetLookalikeRequestsParams): Promise<Responses.AdsGetLookalikeRequestsResponse>; getMusicians(params: Params.AdsGetMusiciansParams): Promise<Responses.AdsGetMusiciansResponse>; getMusiciansByIds(params: Params.AdsGetMusiciansByIdsParams): Promise<Responses.AdsGetMusiciansResponse>; /** * Returns a list of managers and supervisors of advertising account. */ getOfficeUsers(params: Params.AdsGetOfficeUsersParams): Promise<Responses.AdsGetOfficeUsersResponse>; /** * Returns detailed statistics of promoted posts reach from campaigns and ads. */ getPostsReach(params: Params.AdsGetPostsReachParams): Promise<Responses.AdsGetPostsReachResponse>; /** * Returns a reason of ad rejection for pre-moderation. */ getRejectionReason(params: Params.AdsGetRejectionReasonParams): Promise<Responses.AdsGetRejectionReasonResponse>; /** * Returns statistics of performance indicators for ads, campaigns, clients or the whole account. */ getStatistics(params: Params.AdsGetStatisticsParams): Promise<Responses.AdsGetStatisticsResponse>; /** * Returns a set of auto-suggestions for various targeting parameters. */ getSuggestions(params: Params.AdsGetSuggestionsParams): Promise<Responses.AdsGetSuggestionsResponse>; /** * Returns a list of target groups. */ getTargetGroups(params: Params.AdsGetTargetGroupsParams): Promise<Responses.AdsGetTargetGroupsResponse>; getTargetPixels(params: Params.AdsGetTargetPixelsParams): Promise<Responses.AdsGetTargetPixelsResponse>; /** * Returns the size of targeting audience, and also recommended values for CPC and CPM. */ getTargetingStats(params: Params.AdsGetTargetingStatsParams): Promise<Responses.AdsGetTargetingStatsResponse>; /** * Returns URL to upload an ad photo to. */ getUploadURL(params: Params.AdsGetUploadURLParams): Promise<Responses.AdsGetUploadURLResponse>; /** * Returns URL to upload an ad video to. */ getVideoUploadURL(params: Params.AdsGetVideoUploadURLParams): Promise<Responses.AdsGetVideoUploadURLResponse>; /** * Imports a list of advertiser's contacts to count VK registered users against the target group. */ importTargetContacts(params: Params.AdsImportTargetContactsParams): Promise<Responses.AdsImportTargetContactsResponse>; /** * Removes managers and/or supervisors from advertising account. */ removeOfficeUsers(params: Params.AdsRemoveOfficeUsersParams): Promise<Responses.AdsRemoveOfficeUsersResponse>; removeTargetContacts(params: Params.AdsRemoveTargetContactsParams): Promise<Responses.AdsRemoveTargetContactsResponse>; saveLookalikeRequestResult(params: Params.AdsSaveLookalikeRequestResultParams): Promise<Responses.AdsSaveLookalikeRequestResultResponse>; shareTargetGroup(params: Params.AdsShareTargetGroupParams): Promise<Responses.AdsShareTargetGroupResponse>; /** * Edits ads. */ updateAds(params: Params.AdsUpdateAdsParams): Promise<Responses.AdsUpdateAdsResponse>; /** * Edits advertising campaigns. */ updateCampaigns(params: Params.AdsUpdateCampaignsParams): Promise<Responses.AdsUpdateCampaignsResponse>; /** * Edits clients of an advertising agency. */ updateClients(params: Params.AdsUpdateClientsParams): Promise<Responses.AdsUpdateClientsResponse>; /** * Adds managers and/or supervisors to advertising account. */ updateOfficeUsers(params: Params.AdsUpdateOfficeUsersParams): Promise<Responses.AdsUpdateOfficeUsersResponse>; /** * Edits a retarget group. */ updateTargetGroup(params: Params.AdsUpdateTargetGroupParams): Promise<Responses.BaseOkResponse>; updateTargetPixel(params: Params.AdsUpdateTargetPixelParams): Promise<Responses.BaseUndefinedResponse>; } /** * The API adsweb group */ export interface APIAdsweb { getAdCategories(params: Params.AdswebGetAdCategoriesParams): Promise<Responses.AdswebGetAdCategoriesResponse>; getAdUnitCode(params: Params.AdswebGetAdUnitCodeParams): Promise<Responses.AdswebGetAdUnitCodeResponse>; getAdUnits(params: Params.AdswebGetAdUnitsParams): Promise<Responses.AdswebGetAdUnitsResponse>; getFraudHistory(params: Params.AdswebGetFraudHistoryParams): Promise<Responses.AdswebGetFraudHistoryResponse>; getSites(params: Params.AdswebGetSitesParams): Promise<Responses.AdswebGetSitesResponse>; getStatistics(params: Params.AdswebGetStatisticsParams): Promise<Responses.AdswebGetStatisticsResponse>; } /** * The API apps group */ export interface APIApps { addUsersToTestingGroup(params: Params.AppsAddUsersToTestingGroupParams): Promise<Responses.BaseBoolResponse>; /** * Deletes all request notifications from the current app. */ deleteAppRequests(params: Params.AppsDeleteAppRequestsParams): Promise<Responses.BaseOkResponse>; /** * Returns applications data. */ get(params: Params.AppsGetParams): Promise<Responses.AppsGetResponse>; /** * Returns a list of applications (apps) available to users in the App Catalog. */ getCatalog(params: Params.AppsGetCatalogParams): Promise<Responses.AppsGetCatalogResponse>; /** * Creates friends list for requests and invites in current app. */ getFriendsList(params: Params.AppsGetFriendsListParams): Promise<Responses.AppsGetFriendsListResponse>; getLastUploadedVersion(params: Params.AppsGetLastUploadedVersionParams): Promise<Responses.AppsGetLastUploadedVersionResponse>; /** * Returns players rating in the game. */ getLeaderboard(params: Params.AppsGetLeaderboardParams): Promise<Responses.AppsGetLeaderboardResponse>; /** * Returns policies and terms given to a mini app. */ getMiniAppPolicies(params: Params.AppsGetMiniAppPoliciesParams): Promise<Responses.AppsGetMiniAppPoliciesResponse>; /** * Returns scopes for auth */ getScopes(params: Params.AppsGetScopesParams): Promise<Responses.AppsGetScopesResponse>; /** * Returns user score in app */ getScore(params: Params.AppsGetScoreParams): Promise<Responses.AppsGetScoreResponse>; getTestingGroups(params: Params.AppsGetTestingGroupsParams): Promise<Responses.AppsGetTestingGroupsResponse>; isNotificationsAllowed(params: Params.AppsIsNotificationsAllowedParams): Promise<Responses.AppsIsNotificationsAllowedResponse>; promoHasActiveGift(params: Params.AppsPromoHasActiveGiftParams): Promise<Responses.BaseBoolResponse>; promoUseGift(params: Params.AppsPromoUseGiftParams): Promise<Responses.BaseBoolResponse>; removeTestingGroup(params: Params.AppsRemoveTestingGroupParams): Promise<Responses.BaseBoolResponse>; removeUsersFromTestingGroups(params: Params.AppsRemoveUsersFromTestingGroupsParams): Promise<Responses.BaseBoolResponse>; /** * Sends a request to another user in an app that uses VK authorization. */ sendRequest(params: Params.AppsSendRequestParams): Promise<Responses.AppsSendRequestResponse>; updateMetaForTestingGroup(params: Params.AppsUpdateMetaForTestingGroupParams): Promise<Responses.AppsCreatedGroupResponse>; } /** * The API appWidgets group */ export interface APIAppWidgets { /** * Returns a URL for uploading a photo to the community collection for community app widgets */ getAppImageUploadServer(params: Params.AppWidgetsGetAppImageUploadServerParams): Promise<Responses.AppWidgetsGetAppImageUploadServerResponse>; /** * Returns an app collection of images for community app widgets */ getAppImages(params: Params.AppWidgetsGetAppImagesParams): Promise<Responses.AppWidgetsGetAppImagesResponse>; /** * Returns a URL for uploading a photo to the community collection for community app widgets */ getGroupImageUploadServer(params: Params.AppWidgetsGetGroupImageUploadServerParams): Promise<Responses.AppWidgetsGetGroupImageUploadServerResponse>; /** * Returns a community collection of images for community app widgets */ getGroupImages(params: Params.AppWidgetsGetGroupImagesParams): Promise<Responses.AppWidgetsGetGroupImagesResponse>; /** * Returns an image for community app widgets by its ID */ getImagesById(params: Params.AppWidgetsGetImagesByIdParams): Promise<Responses.AppWidgetsGetImagesByIdResponse>; /** * Allows to save image into app collection for community app widgets */ saveAppImage(params: Params.AppWidgetsSaveAppImageParams): Promise<Responses.AppWidgetsSaveAppImageResponse>; /** * Allows to save image into community collection for community app widgets */ saveGroupImage(params: Params.AppWidgetsSaveGroupImageParams): Promise<Responses.AppWidgetsSaveGroupImageResponse>; /** * Allows to update community app widget */ update(params: Params.AppWidgetsUpdateParams): Promise<Responses.BaseOkResponse>; } /** * The API asr group */ export interface APIAsr { /** * Returns status of the task with provided `task_id` */ checkStatus(params: Params.AsrCheckStatusParams): Promise<Responses.AsrCheckStatusResponse>; /** * Returns the server address to [vk.com/dev/upload_files_2|upload audio files]. */ getUploadUrl(params: Params.AsrGetUploadUrlParams): Promise<Responses.BaseGetUploadServerResponse>; /** * Starts ASR task on [vk.com/dev/upload_files_2|uploaded audio file]. */ process(params: Params.AsrProcessParams): Promise<Responses.AsrProcessResponse>; } /** * The API auth group */ export interface APIAuth { /** * Allows to restore account access using a code received via SMS. " This method is only available for apps with [vk.com/dev/auth_direct|Direct authorization] access. " */ restore(params: Params.AuthRestoreParams): Promise<Responses.AuthRestoreResponse>; } /** * The API board group */ export interface APIBoard { /** * Creates a new topic on a community's discussion board. */ addTopic(params: Params.BoardAddTopicParams): Promise<Responses.BoardAddTopicResponse>; /** * Closes a topic on a community's discussion board so that comments cannot be posted. */ closeTopic(params: Params.BoardCloseTopicParams): Promise<Responses.BaseOkResponse>; /** * Adds a comment on a topic on a community's discussion board. */ createComment(params: Params.BoardCreateCommentParams): Promise<Responses.BoardCreateCommentResponse>; /** * Deletes a comment on a topic on a community's discussion board. */ deleteComment(params: Params.BoardDeleteCommentParams): Promise<Responses.BaseOkResponse>; /** * Deletes a topic from a community's discussion board. */ deleteTopic(params: Params.BoardDeleteTopicParams): Promise<Responses.BaseOkResponse>; /** * Edits a comment on a topic on a community's discussion board. */ editComment(params: Params.BoardEditCommentParams): Promise<Responses.BaseOkResponse>; /** * Edits the title of a topic on a community's discussion board. */ editTopic(params: Params.BoardEditTopicParams): Promise<Responses.BaseOkResponse>; /** * Pins a topic (fixes its place) to the top of a community's discussion board. */ fixTopic(params: Params.BoardFixTopicParams): Promise<Responses.BaseOkResponse>; /** * Returns a list of comments on a topic on a community's discussion board. */ getComments(params: Params.BoardGetCommentsParams): Promise<Responses.BoardGetCommentsResponse>; /** * Returns a list of topics on a community's discussion board. */ getTopics(params: Params.BoardGetTopicsParams): Promise<Responses.BoardGetTopicsResponse>; /** * Re-opens a previously closed topic on a community's discussion board. */ openTopic(params: Params.BoardOpenTopicParams): Promise<Responses.BaseOkResponse>; /** * Restores a comment deleted from a topic on a community's discussion board. */ restoreComment(params: Params.BoardRestoreCommentParams): Promise<Responses.BaseOkResponse>; /** * Unpins a pinned topic from the top of a community's discussion board. */ unfixTopic(params: Params.BoardUnfixTopicParams): Promise<Responses.BaseOkResponse>; } /** * The API bugtracker group */ export interface APIBugtracker { addCompanyGroupsMembers(params: Params.BugtrackerAddCompanyGroupsMembersParams): Promise<Responses.BugtrackerAddCompanyGroupsMembersResponse>; addCompanyMembers(params: Params.BugtrackerAddCompanyMembersParams): Promise<Responses.BugtrackerAddCompanyMembersResponse>; changeBugreportStatus(params: Params.BugtrackerChangeBugreportStatusParams): Promise<Responses.BaseBoolResponse>; /** * Creates the comment to bugreport */ createComment(params: Params.BugtrackerCreateCommentParams): Promise<Responses.BugtrackerCreateCommentResponse>; getCompanyGroupMembers(params: Params.BugtrackerGetCompanyGroupMembersParams): Promise<Responses.BugtrackerGetCompanyGroupMembersResponse>; getCompanyMembers(params: Params.BugtrackerGetCompanyMembersParams): Promise<Responses.BugtrackerGetCompanyMembersResponse>; getDownloadVersionUrl(params: Params.BugtrackerGetDownloadVersionUrlParams): Promise<Responses.BugtrackerGetDownloadVersionUrlResponse>; getProductBuildUploadServer(params: Params.BugtrackerGetProductBuildUploadServerParams): Promise<Responses.BaseGetUploadServerResponse>; removeCompanyGroupMember(params: Params.BugtrackerRemoveCompanyGroupMemberParams): Promise<Responses.BaseOkResponse>; removeCompanyMember(params: Params.BugtrackerRemoveCompanyMemberParams): Promise<Responses.BaseOkResponse>; saveProductVersion(params: Params.BugtrackerSaveProductVersionParams): Promise<Responses.BaseOkResponse>; setCompanyMemberRole(params: Params.BugtrackerSetCompanyMemberRoleParams): Promise<Responses.BaseOkResponse>; setProductIsOver(params: Params.BugtrackerSetProductIsOverParams): Promise<Responses.BaseOkResponse>; } /** * The API calls group */ export interface APICalls { forceFinish(params: Params.CallsForceFinishParams): Promise<Responses.BaseOkResponse>; start(params: Params.CallsStartParams): Promise<Responses.CallsStartResponse>; } /** * The API database group */ export interface APIDatabase { /** * Returns list of chairs on a specified faculty. */ getChairs(params: Params.DatabaseGetChairsParams): Promise<Responses.DatabaseGetChairsResponse>; /** * Returns a list of cities. */ getCities(params: Params.DatabaseGetCitiesParams): Promise<Responses.DatabaseGetCitiesResponse>; /** * Returns information about cities by their IDs. */ getCitiesById(params: Params.DatabaseGetCitiesByIdParams): Promise<Responses.DatabaseGetCitiesByIdResponse>; /** * Returns a list of countries. */ getCountries(params: Params.DatabaseGetCountriesParams): Promise<Responses.DatabaseGetCountriesResponse>; /** * Returns information about countries by their IDs. */ getCountriesById(params: Params.DatabaseGetCountriesByIdParams): Promise<Responses.DatabaseGetCountriesByIdResponse>; /** * Returns a list of faculties (i.e., university departments). */ getFaculties(params: Params.DatabaseGetFacultiesParams): Promise<Responses.DatabaseGetFacultiesResponse>; /** * Get metro stations by city */ getMetroStations(params: Params.DatabaseGetMetroStationsParams): Promise<Responses.DatabaseGetMetroStationsResponse>; /** * Get metro station by his id */ getMetroStationsById(params: Params.DatabaseGetMetroStationsByIdParams): Promise<Responses.DatabaseGetMetroStationsByIdResponse>; /** * Returns a list of regions. */ getRegions(params: Params.DatabaseGetRegionsParams): Promise<Responses.DatabaseGetRegionsResponse>; /** * Returns a list of school classes specified for the country. */ getSchoolClasses(params: Params.DatabaseGetSchoolClassesParams): Promise<Responses.DatabaseGetSchoolClassesNewResponse>; /** * Returns a list of schools. */ getSchools(params: Params.DatabaseGetSchoolsParams): Promise<Responses.DatabaseGetSchoolsResponse>; /** * Returns a list of higher education institutions. */ getUniversities(params: Params.DatabaseGetUniversitiesParams): Promise<Responses.DatabaseGetUniversitiesResponse>; } /** * The API docs group */ export interface APIDocs { /** * Copies a document to a user's or community's document list. */ add(params: Params.DocsAddParams): Promise<Responses.DocsAddResponse>; /** * Deletes a user or community document. */ delete(params: Params.DocsDeleteParams): Promise<Responses.BaseOkResponse>; /** * Edits a document. */ edit(params: Params.DocsEditParams): Promise<Responses.BaseOkResponse>; /** * Returns detailed information about user or community documents. */ get(params: Params.DocsGetParams): Promise<Responses.DocsGetResponse>; /** * Returns information about documents by their IDs. */ getById(params: Params.DocsGetByIdParams): Promise<Responses.DocsGetByIdResponse>; /** * Returns the server address for document upload. */ getMessagesUploadServer(params: Params.DocsGetMessagesUploadServerParams): Promise<Responses.DocsGetUploadServerResponse>; /** * Returns documents types available for current user. */ getTypes(params: Params.DocsGetTypesParams): Promise<Responses.DocsGetTypesResponse>; /** * Returns the server address for document upload. */ getUploadServer(params: Params.DocsGetUploadServerParams): Promise<Responses.DocsGetUploadServerResponse>; /** * Returns the server address for document upload onto a user's or community's wall. */ getWallUploadServer(params: Params.DocsGetWallUploadServerParams): Promise<Responses.BaseGetUploadServerResponse>; /** * Saves a document after [vk.com/dev/upload_files_2|uploading it to a server]. */ save(params: Params.DocsSaveParams): Promise<Responses.DocsSaveResponse>; /** * Returns a list of documents matching the search criteria. */ search(params: Params.DocsSearchParams): Promise<Responses.DocsSearchResponse>; } /** * The API donut group */ export interface APIDonut { getFriends(params: Params.DonutGetFriendsParams): Promise<Responses.GroupsGetMembersFieldsResponse>; getSubscription(params: Params.DonutGetSubscriptionParams): Promise<Responses.DonutGetSubscriptionResponse>; /** * Returns a list of user's VK Donut subscriptions. */ getSubscriptions(params: Params.DonutGetSubscriptionsParams): Promise<Responses.DonutGetSubscriptionsResponse>; isDon(params: Params.DonutIsDonParams): Promise<Responses.BaseBoolResponse>; } /** * The API downloadedGames group */ export interface APIDownloadedGames { getPaidStatus(params: Params.DownloadedGamesGetPaidStatusParams): Promise<Responses.DownloadedGamesPaidStatusResponse>; } /** * The API fave group */ export interface APIFave { addArticle(params: Params.FaveAddArticleParams): Promise<Responses.BaseOkResponse>; /** * Adds a link to user faves. */ addLink(params: Params.FaveAddLinkParams): Promise<Responses.BaseOkResponse>; addPage(params: Params.FaveAddPageParams): Promise<Responses.BaseOkResponse>; addPost(params: Params.FaveAddPostParams): Promise<Responses.BaseOkResponse>; addProduct(params: Params.FaveAddProductParams): Promise<Responses.BaseOkResponse>; addTag(params: Params.FaveAddTagParams): Promise<Responses.FaveAddTagResponse>; addVideo(params: Params.FaveAddVideoParams): Promise<Responses.BaseOkResponse>; editTag(params: Params.FaveEditTagParams): Promise<Responses.BaseOkResponse>; get(params: Params.FaveGetParams): Promise<Responses.FaveGetResponse>; getPages(params: Params.FaveGetPagesParams): Promise<Responses.FaveGetPagesResponse>; getTags(params: Params.FaveGetTagsParams): Promise<Responses.FaveGetTagsResponse>; markSeen(params: Params.FaveMarkSeenParams): Promise<Responses.BaseBoolResponse>; removeArticle(params: Params.FaveRemoveArticleParams): Promise<Responses.BaseBoolResponse>; /** * Removes link from the user's faves. */ removeLink(params: Params.FaveRemoveLinkParams): Promise<Responses.BaseOkResponse>; removePage(params: Params.FaveRemovePageParams): Promise<Responses.BaseOkResponse>; removePost(params: Params.FaveRemovePostParams): Promise<Responses.BaseOkResponse>; removeProduct(params: Params.FaveRemoveProductParams): Promise<Responses.BaseOkResponse>; removeTag(params: Params.FaveRemoveTagParams): Promise<Responses.BaseOkResponse>; removeVideo(params: Params.FaveRemoveVideoParams): Promise<Responses.BaseOkResponse>; reorderTags(params: Params.FaveReorderTagsParams): Promise<Responses.BaseOkResponse>; setPageTags(params: Params.FaveSetPageTagsParams): Promise<Responses.BaseOkResponse>; setTags(params: Params.FaveSetTagsParams): Promise<Responses.BaseOkResponse>; trackPageInteraction(params: Params.FaveTrackPageInteractionParams): Promise<Responses.BaseOkResponse>; } /** * The API friends group */ export interface APIFriends { /** * Approves or creates a friend request. */ add(params: Params.FriendsAddParams): Promise<Responses.FriendsAddResponse>; /** * Creates a new friend list for the current user. */ addList(params: Params.FriendsAddListParams): Promise<Responses.FriendsAddListResponse>; /** * Checks the current user's friendship status with other specified users. */ areFriends(params: Params.FriendsAreFriendsParams): Promise<Responses.FriendsAreFriendsResponse>; /** * Declines a friend request or deletes a user from the current user's friend list. */ delete(params: Params.FriendsDeleteParams): Promise<Responses.FriendsDeleteResponse>; /** * Marks all incoming friend requests as viewed. */ deleteAllRequests(params: Params.FriendsDeleteAllRequestsParams): Promise<Responses.BaseOkResponse>; /** * Deletes a friend list of the current user. */ deleteList(params: Params.FriendsDeleteListParams): Promise<Responses.BaseOkResponse>; /** * Edits the friend lists of the selected user. */ edit(params: Params.FriendsEditParams): Promise<Responses.BaseOkResponse>; /** * Edits a friend list of the current user. */ editList(params: Params.FriendsEditListParams): Promise<Responses.BaseOkResponse>; /** * Returns a list of user IDs or detailed information about a user's friends. */ get(params: Params.FriendsGetParams): Promise<Responses.FriendsGetResponse>; /** * Returns a list of IDs of the current user's friends who installed the application. */ getAppUsers(params: Params.FriendsGetAppUsersParams): Promise<Responses.FriendsGetAppUsersResponse>; /** * Returns a list of the current user's friends whose phone numbers, validated or specified in a profile, are in a given list. */ getByPhones(params: Params.FriendsGetByPhonesParams): Promise<Responses.FriendsGetByPhonesResponse>; /** * Returns a list of the user's friend lists. */ getLists(params: Params.FriendsGetListsParams): Promise<Responses.FriendsGetListsResponse>; /** * Returns a list of user IDs of the mutual friends of two users. */ getMutual(params: Params.FriendsGetMutualParams): Promise<Responses.FriendsGetMutualResponse>; /** * Returns a list of user IDs of a user's friends who are online. */ getOnline(params: Params.FriendsGetOnlineParams): Promise<Responses.FriendsGetOnlineResponse>; /** * Returns a list of user IDs of the current user's recently added friends. */ getRecent(params: Params.FriendsGetRecentParams): Promise<Responses.FriendsGetRecentResponse>; /** * Returns information about the current user's incoming and outgoing friend requests. */ getRequests(params: Params.FriendsGetRequestsParams): Promise<Responses.FriendsGetRequestsResponse>; /** * Returns a list of profiles of users whom the current user may know. */ getSuggestions(params: Params.FriendsGetSuggestionsParams): Promise<Responses.FriendsGetSuggestionsResponse>; /** * Returns a list of friends matching the search criteria. */ search(params: Params.FriendsSearchParams): Promise<Responses.FriendsSearchResponse>; } /** * The API gifts group */ export interface APIGifts { /** * Returns a list of user gifts. */ get(params: Params.GiftsGetParams): Promise<Responses.GiftsGetResponse>; } /** * The API groups group */ export interface APIGroups { addAddress(params: Params.GroupsAddAddressParams): Promise<Responses.GroupsAddAddressResponse>; addCallbackServer(params: Params.GroupsAddCallbackServerParams): Promise<Responses.GroupsAddCallbackServerResponse>; /** * Allows to add a link to the community. */ addLink(params: Params.GroupsAddLinkParams): Promise<Responses.GroupsAddLinkResponse>; /** * Allows to approve join request to the community. */ approveRequest(params: Params.GroupsApproveRequestParams): Promise<Responses.BaseOkResponse>; ban(params: Params.GroupsBanParams): Promise<Responses.BaseOkResponse>; /** * Creates a new community. */ create(params: Params.GroupsCreateParams): Promise<Responses.GroupsCreateResponse>; deleteAddress(params: Params.GroupsDeleteAddressParams): Promise<Responses.BaseOkResponse>; deleteCallbackServer(params: Params.GroupsDeleteCallbackServerParams): Promise<Responses.BaseOkResponse>; /** * Allows to delete a link from the community. */ deleteLink(params: Params.GroupsDeleteLinkParams): Promise<Responses.BaseOkResponse>; disableOnline(params: Params.GroupsDisableOnlineParams): Promise<Responses.BaseOkResponse>; /** * Edits a community. */ edit(params: Params.GroupsEditParams): Promise<Responses.BaseOkResponse>; editAddress(params: Params.GroupsEditAddressParams): Promise<Responses.GroupsEditAddressResponse>; editCallbackServer(params: Params.GroupsEditCallbackServerParams): Promise<Responses.BaseOkResponse>; /** * Allows to edit a link in the community. */ editLink(params: Params.GroupsEditLinkParams): Promise<Responses.BaseOkResponse>; /** * Allows to add, remove or edit the community manager. */ editManager(params: Params.GroupsEditManagerParams): Promise<Responses.BaseOkResponse>; enableOnline(params: Params.GroupsEnableOnlineParams): Promise<Responses.BaseOkResponse>; /** * Returns a list of the communities to which a user belongs. */ get(params: Params.GroupsGetParams): Promise<Responses.GroupsGetResponse>; /** * Returns a list of community addresses. */ getAddresses(params: Params.GroupsGetAddressesParams): Promise<Responses.GroupsGetAddressesResponse>; /** * Returns a list of users on a community blacklist. */ getBanned(params: Params.GroupsGetBannedParams): Promise<Responses.GroupsGetBannedResponse>; /** * Returns information about communities by their IDs. */ getById(params: Params.GroupsGetByIdParams): Promise<Responses.GroupsGetByIdObjectResponse>; /** * Returns Callback API confirmation code for the community. */ getCallbackConfirmationCode(params: Params.GroupsGetCallbackConfirmationCodeParams): Promise<Responses.GroupsGetCallbackConfirmationCodeResponse>; getCallbackServers(params: Params.GroupsGetCallbackServersParams): Promise<Responses.GroupsGetCallbackServersResponse>; /** * Returns [vk.com/dev/callback_api|Callback API] notifications settings. */ getCallbackSettings(params: Params.GroupsGetCallbackSettingsParams): Promise<Responses.GroupsGetCallbackSettingsResponse>; /** * Returns categories list for communities catalog */ getCatalogInfo(params: Params.GroupsGetCatalogInfoParams): Promise<Responses.GroupsGetCatalogInfoResponse>; /** * Returns invited users list of a community */ getInvitedUsers(params: Params.GroupsGetInvitedUsersParams): Promise<Responses.GroupsGetInvitedUsersResponse>; /** * Returns a list of invitations to join communities and events. */ getInvites(params: Params.GroupsGetInvitesParams): Promise<Responses.GroupsGetInvitesResponse>; /** * Returns the data needed to query a Long Poll server for events */ getLongPollServer(params: Params.GroupsGetLongPollServerParams): Promise<Responses.GroupsGetLongPollServerResponse>; /** * Returns Long Poll notification settings */ getLongPollSettings(params: Params.GroupsGetLongPollSettingsParams): Promise<Responses.GroupsGetLongPollSettingsResponse>; /** * Returns a list of community members. */ getMembers(params: Params.GroupsGetMembersParams): Promise<Responses.GroupsGetMembersResponse>; getOnlineStatus(params: Params.GroupsGetOnlineStatusParams): Promise<Responses.GroupsGetOnlineStatusResponse>; /** * Returns a list of requests to the community. */ getRequests(params: Params.GroupsGetRequestsParams): Promise<Responses.GroupsGetRequestsResponse>; /** * Returns community settings. */ getSettings(params: Params.GroupsGetSettingsParams): Promise<Responses.GroupsGetSettingsResponse>; /** * List of group's tags */ getTagList(params: Params.GroupsGetTagListParams): Promise<Responses.GroupsGetTagListResponse>; getTokenPermissions(params: Params.GroupsGetTokenPermissionsParams): Promise<Responses.GroupsGetTokenPermissionsResponse>; /** * Allows to invite friends to the community. */ invite(params: Params.GroupsInviteParams): Promise<Responses.BaseOkResponse>; /** * Returns information specifying whether a user is a member of a community. */ isMember(params: Params.GroupsIsMemberParams): Promise<Responses.BaseBoolResponse>; /** * With this method you can join the group or public page, and also confirm your participation in an event. */ join(params: Params.GroupsJoinParams): Promise<Responses.BaseOkResponse>; /** * With this method you can leave a group, public page, or event. */ leave(params: Params.GroupsLeaveParams): Promise<Responses.BaseOkResponse>; /** * Removes a user from the community. */ removeUser(params: Params.GroupsRemoveUserParams): Promise<Responses.BaseOkResponse>; /** * Allows to reorder links in the community. */ reorderLink(params: Params.GroupsReorderLinkParams): Promise<Responses.BaseOkResponse>; /** * Returns a list of communities matching the search criteria. */ search(params: Params.GroupsSearchParams): Promise<Responses.GroupsSearchResponse>; /** * Allow to set notifications settings for group. */ setCallbackSettings(params: Params.GroupsSetCallbackSettingsParams): Promise<Responses.BaseOkResponse>; /** * Sets Long Poll notification settings */ setLongPollSettings(params: Params.GroupsSetLongPollSettingsParams): Promise<Responses.BaseOkResponse>; setSettings(params: Params.GroupsSetSettingsParams): Promise<Responses.BaseOkResponse>; /** * In order to save note about group participant */ setUserNote(params: Params.GroupsSetUserNoteParams): Promise<Responses.BaseBoolResponse>; /** * Add new group's tag */ tagAdd(params: Params.GroupsTagAddParams): Promise<Responses.BaseBoolResponse>; /** * Bind or unbind group's tag to user */ tagBind(params: Params.GroupsTagBindParams): Promise<Responses.BaseBoolResponse>; /** * Delete group's tag */ tagDelete(params: Params.GroupsTagDeleteParams): Promise<Responses.BaseBoolResponse>; /** * Update group's tag */ tagUpdate(params: Params.GroupsTagUpdateParams): Promise<Responses.BaseBoolResponse>; toggleMarket(params: Params.GroupsToggleMarketParams): Promise<Responses.BaseOkResponse>; unban(params: Params.GroupsUnbanParams): Promise<Responses.BaseOkResponse>; } /** * The API leadForms group */ export interface APILeadForms { create(params: Params.LeadFormsCreateParams): Promise<Responses.LeadFormsCreateResponse>; delete(params: Params.LeadFormsDeleteParams): Promise<Responses.LeadFormsDeleteResponse>; get(params: Params.LeadFormsGetParams): Promise<Responses.LeadFormsGetResponse>; getLeads(params: Params.LeadFormsGetLeadsParams): Promise<Responses.LeadFormsGetLeadsResponse>; getUploadURL(params: Params.LeadFormsGetUploadURLParams): Promise<Responses.LeadFormsUploadUrlResponse>; list(params: Params.LeadFormsListParams): Promise<Responses.LeadFormsListResponse>; update(params: Params.LeadFormsUpdateParams): Promise<Responses.LeadFormsCreateResponse>; } /** * The API likes group */ export interface APILikes { /** * Adds the specified object to the 'Likes' list of the current user. */ add(params: Params.LikesAddParams): Promise<Responses.LikesAddResponse>; /** * Deletes the specified object from the 'Likes' list of the current user. */ delete(params: Params.LikesDeleteParams): Promise<Responses.LikesDeleteResponse>; /** * Returns a list of IDs of users who added the specified object to their 'Likes' list. */ getList(params: Params.LikesGetListParams): Promise<Responses.LikesGetListResponse>; /** * Checks for the object in the 'Likes' list of the specified user. */ isLiked(params: Params.LikesIsLikedParams): Promise<Responses.LikesIsLikedResponse>; } /** * The API market group */ export interface APIMarket { /** * Ads a new item to the market. */ add(params: Params.MarketAddParams): Promise<Responses.MarketAddResponse>; /** * Creates new collection of items */ addAlbum(params: Params.MarketAddAlbumParams): Promise<Responses.MarketAddAlbumResponse>; /** * Adds an item to one or multiple collections. */ addToAlbum(params: Params.MarketAddToAlbumParams): Promise<Responses.BaseOkResponse>; /** * Creates a new comment for an item. */ createComment(params: Params.MarketCreateCommentParams): Promise<Responses.MarketCreateCommentResponse>; /** * Deletes an item. */ delete(params: Params.MarketDeleteParams): Promise<Responses.BaseOkResponse>; /** * Deletes a collection of items. */ deleteAlbum(params: Params.MarketDeleteAlbumParams): Promise<Responses.BaseOkResponse>; /** * Deletes an item's comment */ deleteComment(params: Params.MarketDeleteCommentParams): Promise<Responses.BaseBoolResponse>; /** * Edits an item. */ edit(params: Params.MarketEditParams): Promise<Responses.BaseOkResponse>; /** * Edits a collection of items */ editAlbum(params: Params.MarketEditAlbumParams): Promise<Responses.BaseOkResponse>; /** * Chages item comment's text */ editComment(params: Params.MarketEditCommentParams): Promise<Responses.BaseOkResponse>; /** * Edit order */ editOrder(params: Params.MarketEditOrderParams): Promise<Responses.BaseOkResponse>; /** * Returns a filter list of market categories. */ filterCategories(params: Params.MarketFilterCategoriesParams): Promise<Responses.MarketGetCategoriesNewResponse>; /** * Returns items list for a community. */ get(params: Params.MarketGetParams): Promise<Responses.MarketGetResponse>; /** * Returns items album's data */ getAlbumById(params: Params.MarketGetAlbumByIdParams): Promise<Responses.MarketGetAlbumByIdResponse>; /** * Returns community's market collections list. */ getAlbums(params: Params.MarketGetAlbumsParams): Promise<Responses.MarketGetAlbumsResponse>; /** * Returns information about market items by their ids. */ getById(params: Params.MarketGetByIdParams): Promise<Responses.MarketGetByIdResponse>; /** * Returns a list of market categories. */ getCategories(params: Params.MarketGetCategoriesParams): Promise<Responses.MarketGetCategoriesNewResponse>; /** * Returns comments list for an item. */ getComments(params: Params.MarketGetCommentsParams): Promise<Responses.MarketGetCommentsResponse>; /** * Get market orders */ getGroupOrders(params: Params.MarketGetGroupOrdersParams): Promise<Responses.MarketGetGroupOrdersResponse>; /** * Get order */ getOrderById(params: Params.MarketGetOrderByIdParams): Promise<Responses.MarketGetOrderByIdResponse>; /** * Get market items in the order */ getOrderItems(params: Params.MarketGetOrderItemsParams): Promise<Responses.MarketGetOrderItemsResponse>; getOrders(params: Params.MarketGetOrdersParams): Promise<Responses.MarketGetOrdersResponse>; /** * Removes an item from one or multiple collections. */ removeFromAlbum(params: Params.MarketRemoveFromAlbumParams): Promise<Responses.BaseOkResponse>; /** * Reorders the collections list. */ reorderAlbums(params: Params.MarketReorderAlbumsParams): Promise<Responses.BaseOkResponse>; /** * Changes item place in a collection. */ reorderItems(params: Params.MarketReorderItemsParams): Promise<Responses.BaseOkResponse>; /** * Sends a complaint to the item. */ report(params: Params.MarketReportParams): Promise<Responses.BaseOkResponse>; /** * Sends a complaint to the item's comment. */ reportComment(params: Params.MarketReportCommentParams): Promise<Responses.BaseOkResponse>; /** * Restores recently deleted item */ restore(params: Params.MarketRestoreParams): Promise<Responses.BaseOkResponse>; /** * Restores a recently deleted comment */ restoreComment(params: Params.MarketRestoreCommentParams): Promise<Responses.BaseBoolResponse>; /** * Searches market items in a community's catalog */ search(params: Params.MarketSearchParams): Promise<Responses.MarketSearchResponse>; searchItems(params: Params.MarketSearchItemsParams): Promise<Responses.MarketSearchResponse>; searchItemsBasic(params: Params.MarketSearchItemsBasicParams): Promise<Responses.MarketSearchBasicResponse>; } /** * The API messages group */ export interface APIMessages { /** * Adds a new user to a chat. */ addChatUser(params: Params.MessagesAddChatUserParams): Promise<Responses.BaseOkResponse>; /** * Adds new users to a chat. */ addChatUsers(params: Params.MessagesAddChatUsersParams): Promise<Responses.MessagesAddChatUsersResponse>; /** * Allows sending messages from community to the current user. */ allowMessagesFromGroup(params: Params.MessagesAllowMessagesFromGroupParams): Promise<Responses.BaseOkResponse>; /** * Creates a chat with several participants. */ createChat(params: Params.MessagesCreateChatParams): Promise<Responses.MessagesCreateChatWithPeerIdsResponse>; /** * Deletes one or more messages. */ delete(params: Params.MessagesDeleteParams): Promise<Responses.MessagesDeleteFullResponse>; /** * Deletes a chat's cover picture. */ deleteChatPhoto(params: Params.MessagesDeleteChatPhotoParams): Promise<Responses.MessagesDeleteChatPhotoResponse>; /** * Deletes all private messages in a conversation. */ deleteConversation(params: Params.MessagesDeleteConversationParams): Promise<Responses.MessagesDeleteConversationResponse>; /** * Delete message reaction */ deleteReaction(params: Params.MessagesDeleteReactionParams): Promise<Responses.BaseBoolResponse>; /** * Denies sending message from community to the current user. */ denyMessagesFromGroup(params: Params.MessagesDenyMessagesFromGroupParams): Promise<Responses.BaseOkResponse>; /** * Edits the message. */ edit(params: Params.MessagesEditParams): Promise<Responses.BaseBoolResponse>; /** * Edits the title of a chat. */ editChat(params: Params.MessagesEditChatParams): Promise<Responses.BaseOkResponse>; /** * Returns messages by their IDs within the conversation. */ getByConversationMessageId(params: Params.MessagesGetByConversationMessageIdParams): Promise<Responses.MessagesGetByConversationMessageIdResponse>; /** * Returns messages by their IDs. */ getById(params: Params.MessagesGetByIdParams): Promise<Responses.MessagesGetByIdResponse>; /** * Returns information about a chat. */ getChat(params: Params.MessagesGetChatParams): Promise<Responses.MessagesGetChatResponse>; getChatPreview(params: Params.MessagesGetChatPreviewParams): Promise<Responses.MessagesGetChatPreviewResponse>; /** * Returns a list of IDs of users participating in a chat. */ getConversationMembers(params: Params.MessagesGetConversationMembersParams): Promise<Responses.MessagesGetConversationMembersResponse>; /** * Returns a list of the current user's conversations. */ getConversations(params: Params.MessagesGetConversationsParams): Promise<Responses.MessagesGetConversationsResponse>; /** * Returns conversations by their IDs */ getConversationsById(params: Params.MessagesGetConversationsByIdParams): Promise<Responses.MessagesGetConversationsByIdResponse>; /** * Returns message history for the specified user or group chat. */ getHistory(params: Params.MessagesGetHistoryParams): Promise<Responses.MessagesGetHistoryResponse>; /** * Returns media files from the dialog or group chat. */ getHistoryAttachments(params: Params.MessagesGetHistoryAttachmentsParams): Promise<Responses.MessagesGetHistoryAttachmentsResponse>; /** * Returns a list of user's important messages. */ getImportantMessages(params: Params.MessagesGetImportantMessagesParams): Promise<Responses.MessagesGetImportantMessagesResponse>; getIntentUsers(params: Params.MessagesGetIntentUsersParams): Promise<Responses.MessagesGetIntentUsersResponse>; getInviteLink(params: Params.MessagesGetInviteLinkParams): Promise<Responses.MessagesGetInviteLinkResponse>; /** * Returns a user's current status and date of last activity. */ getLastActivity(params: Params.MessagesGetLastActivityParams): Promise<Responses.MessagesGetLastActivityResponse>; /** * Returns updates in user's private messages. */ getLongPollHistory(params