UNPKG

node-vk-sdk

Version:

VK API SDK for Node.js

1,464 lines (1,463 loc) 237 kB
import { BaseVKApi } from "../api/BaseVKApi"; import * as MethodsProps from "./MethodsProps"; import * as Responses from "./Responses"; export declare class VKApi extends BaseVKApi { /** * undefined * * @param {{ * owner_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountBan(params: MethodsProps.AccountBanParams): Promise<Responses.BaseOkResponse>; /** * Changes a user password after access is successfully restored with the [vk.com/dev/auth.restore|auth.restore] method. * * @param {{ * restore_sid: (string|undefined), * change_password_hash: (string|undefined), * old_password: (string|undefined), * new_password: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountChangePasswordResponse>} */ accountChangePassword(params: MethodsProps.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. * * @param {{ * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetActiveOffersResponse>} */ accountGetActiveOffers(params: MethodsProps.AccountGetActiveOffersParams): Promise<Responses.AccountGetActiveOffersResponse>; /** * Gets settings of the user in this application. * * @param {{ * user_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetAppPermissionsResponse>} */ accountGetAppPermissions(params: MethodsProps.AccountGetAppPermissionsParams): Promise<Responses.AccountGetAppPermissionsResponse>; /** * Returns a user's blacklist. * * @param {{ * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetBannedResponse>} */ accountGetBanned(params: MethodsProps.AccountGetBannedParams): Promise<Responses.AccountGetBannedResponse>; /** * Returns non-null values of user counters. * * @param {{ * filter: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetCountersResponse>} */ accountGetCounters(params: MethodsProps.AccountGetCountersParams): Promise<Responses.AccountGetCountersResponse>; /** * Returns current account info. * * @param {{ * fields: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetInfoResponse>} */ accountGetInfo(params: MethodsProps.AccountGetInfoParams): Promise<Responses.AccountGetInfoResponse>; /** * Returns the current account info. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetProfileInfoResponse>} */ accountGetProfileInfo(params: MethodsProps.AccountGetProfileInfoParams): Promise<Responses.AccountGetProfileInfoResponse>; /** * Gets settings of push notifications. * * @param {{ * device_id: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetPushSettingsResponse>} */ accountGetPushSettings(params: MethodsProps.AccountGetPushSettingsParams): Promise<Responses.AccountGetPushSettingsResponse>; /** * Subscribes an iOS/Android/Windows Phone-based device to receive push notifications * * @param {{ * token: (string), * device_model: (string|undefined), * device_year: (number|undefined), * device_id: (string), * system_version: (string|undefined), * settings: (string|undefined), * sandbox: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountRegisterDevice(params: MethodsProps.AccountRegisterDeviceParams): Promise<Responses.BaseOkResponse>; /** * Edits current profile info. * * @param {{ * first_name: (string|undefined), * last_name: (string|undefined), * maiden_name: (string|undefined), * screen_name: (string|undefined), * cancel_request_id: (number|undefined), * sex: (number|undefined), * relation: (number|undefined), * relation_partner_id: (number|undefined), * bdate: (string|undefined), * bdate_visibility: (number|undefined), * home_town: (string|undefined), * country_id: (number|undefined), * city_id: (number|undefined), * status: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountSaveProfileInfoResponse>} */ accountSaveProfileInfo(params: MethodsProps.AccountSaveProfileInfoParams): Promise<Responses.AccountSaveProfileInfoResponse>; /** * Allows to edit the current account info. * * @param {{ * name: (string|undefined), * value: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountSetInfo(params: MethodsProps.AccountSetInfoParams): Promise<Responses.BaseOkResponse>; /** * Sets an application screen name (up to 17 characters), that is shown to the user in the left menu. * * @param {{ * user_id: (number), * name: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountSetNameInMenu(params: MethodsProps.AccountSetNameInMenuParams): Promise<Responses.BaseOkResponse>; /** * Marks a current user as offline. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountSetOffline(params: MethodsProps.AccountSetOfflineParams): Promise<Responses.BaseOkResponse>; /** * Marks the current user as online for 15 minutes. * * @param {{ * voip: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountSetOnline(params: MethodsProps.AccountSetOnlineParams): Promise<Responses.BaseOkResponse>; /** * Change push settings. * * @param {{ * device_id: (string), * settings: (string|undefined), * key: (string|undefined), * value: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountSetPushSettings(params: MethodsProps.AccountSetPushSettingsParams): Promise<Responses.BaseOkResponse>; /** * Mutes push notifications for the set period of time. * * @param {{ * device_id: (string|undefined), * time: (number|undefined), * peer_id: (number|undefined), * sound: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountSetSilenceMode(params: MethodsProps.AccountSetSilenceModeParams): Promise<Responses.BaseOkResponse>; /** * undefined * * @param {{ * owner_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountUnban(params: MethodsProps.AccountUnbanParams): Promise<Responses.BaseOkResponse>; /** * Unsubscribes a device from push notifications. * * @param {{ * device_id: (string|undefined), * sandbox: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ accountUnregisterDevice(params: MethodsProps.AccountUnregisterDeviceParams): Promise<Responses.BaseOkResponse>; /** * Adds managers and/or supervisors to advertising account. * * @param {{ * account_id: (number), * data: (Models.AdsUserSpecificationCutted[]), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsAddOfficeUsersResponse>} */ adsAddOfficeUsers(params: MethodsProps.AdsAddOfficeUsersParams): Promise<Responses.AdsAddOfficeUsersResponse>; /** * Allows to check the ad link. * * @param {{ * account_id: (number), * link_type: (string), * link_url: (string), * campaign_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsCheckLinkResponse>} */ adsCheckLink(params: MethodsProps.AdsCheckLinkParams): Promise<Responses.AdsCheckLinkResponse>; /** * Creates ads. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsCreateAdsResponse>} */ adsCreateAds(params: MethodsProps.AdsCreateAdsParams): Promise<Responses.AdsCreateAdsResponse>; /** * Creates advertising campaigns. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsCreateCampaignsResponse>} */ adsCreateCampaigns(params: MethodsProps.AdsCreateCampaignsParams): Promise<Responses.AdsCreateCampaignsResponse>; /** * Creates clients of an advertising agency. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsCreateClientsResponse>} */ adsCreateClients(params: MethodsProps.AdsCreateClientsParams): Promise<Responses.AdsCreateClientsResponse>; /** * Creates a group to re-target ads for users who visited advertiser's site (viewed information about the product, registered, etc.). * * @param {{ * account_id: (number), * client_id: (number|undefined), * name: (string), * lifetime: (number), * target_pixel_id: (number|undefined), * target_pixel_rules: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsCreateTargetGroupResponse>} */ adsCreateTargetGroup(params: MethodsProps.AdsCreateTargetGroupParams): Promise<Responses.AdsCreateTargetGroupResponse>; /** * Archives ads. * * @param {{ * account_id: (number), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsDeleteAdsResponse>} */ adsDeleteAds(params: MethodsProps.AdsDeleteAdsParams): Promise<Responses.AdsDeleteAdsResponse>; /** * Archives advertising campaigns. * * @param {{ * account_id: (number), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsDeleteCampaignsResponse>} */ adsDeleteCampaigns(params: MethodsProps.AdsDeleteCampaignsParams): Promise<Responses.AdsDeleteCampaignsResponse>; /** * Archives clients of an advertising agency. * * @param {{ * account_id: (number), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsDeleteClientsResponse>} */ adsDeleteClients(params: MethodsProps.AdsDeleteClientsParams): Promise<Responses.AdsDeleteClientsResponse>; /** * Deletes a retarget group. * * @param {{ * account_id: (number), * client_id: (number|undefined), * target_group_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ adsDeleteTargetGroup(params: MethodsProps.AdsDeleteTargetGroupParams): Promise<Responses.BaseOkResponse>; /** * Returns a list of advertising accounts. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetAccountsResponse>} */ adsGetAccounts(params: MethodsProps.AdsGetAccountsParams): Promise<Responses.AdsGetAccountsResponse>; /** * Returns number of ads. * * @param {{ * account_id: (number), * ad_ids: (string|undefined), * campaign_ids: (string|undefined), * client_id: (number|undefined), * include_deleted: (boolean|undefined), * only_deleted: (boolean|undefined), * limit: (number|undefined), * offset: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetAdsResponse>} */ adsGetAds(params: MethodsProps.AdsGetAdsParams): Promise<Responses.AdsGetAdsResponse>; /** * Returns descriptions of ad layouts. * * @param {{ * account_id: (number), * ad_ids: (string|undefined), * campaign_ids: (string|undefined), * client_id: (number|undefined), * include_deleted: (boolean|undefined), * limit: (number|undefined), * offset: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetAdsLayoutResponse>} */ adsGetAdsLayout(params: MethodsProps.AdsGetAdsLayoutParams): Promise<Responses.AdsGetAdsLayoutResponse>; /** * Returns ad targeting parameters. * * @param {{ * account_id: (number), * ad_ids: (string|undefined), * campaign_ids: (string|undefined), * client_id: (number|undefined), * include_deleted: (boolean|undefined), * limit: (number|undefined), * offset: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetAdsTargetingResponse>} */ adsGetAdsTargeting(params: MethodsProps.AdsGetAdsTargetingParams): Promise<Responses.AdsGetAdsTargetingResponse>; /** * Returns current budget of the advertising account. * * @param {{ * account_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetBudgetResponse>} */ adsGetBudget(params: MethodsProps.AdsGetBudgetParams): Promise<Responses.AdsGetBudgetResponse>; /** * Returns a list of campaigns in an advertising account. * * @param {{ * account_id: (number), * client_id: (number|undefined), * include_deleted: (boolean|undefined), * campaign_ids: (string|undefined), * fields: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetCampaignsResponse>} */ adsGetCampaigns(params: MethodsProps.AdsGetCampaignsParams): Promise<Responses.AdsGetCampaignsResponse>; /** * Returns a list of possible ad categories. * * @param {{ * lang: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetCategoriesResponse>} */ adsGetCategories(params: MethodsProps.AdsGetCategoriesParams): Promise<Responses.AdsGetCategoriesResponse>; /** * Returns a list of advertising agency's clients. * * @param {{ * account_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetClientsResponse>} */ adsGetClients(params: MethodsProps.AdsGetClientsParams): Promise<Responses.AdsGetClientsResponse>; /** * Returns demographics for ads or campaigns. * * @param {{ * account_id: (number), * ids_type: (string), * ids: (string), * period: (string), * date_from: (string), * date_to: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetDemographicsResponse>} */ adsGetDemographics(params: MethodsProps.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. * * @param {{ * account_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetFloodStatsResponse>} */ adsGetFloodStats(params: MethodsProps.AdsGetFloodStatsParams): Promise<Responses.AdsGetFloodStatsResponse>; /** * undefined * * @param {{ * account_id: (number), * client_id: (number|undefined), * requests_ids: (string|undefined), * offset: (number|undefined), * limit: (number|undefined), * sort_by: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetLookalikeRequestsResponse>} */ adsGetLookalikeRequests(params: MethodsProps.AdsGetLookalikeRequestsParams): Promise<Responses.AdsGetLookalikeRequestsResponse>; /** * undefined * * @param {{ * artist_name: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetMusiciansResponse>} */ adsGetMusicians(params: MethodsProps.AdsGetMusiciansParams): Promise<Responses.AdsGetMusiciansResponse>; /** * Returns a list of managers and supervisors of advertising account. * * @param {{ * account_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetOfficeUsersResponse>} */ adsGetOfficeUsers(params: MethodsProps.AdsGetOfficeUsersParams): Promise<Responses.AdsGetOfficeUsersResponse>; /** * Returns detailed statistics of promoted posts reach from campaigns and ads. * * @param {{ * account_id: (number), * ids_type: (string), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetPostsReachResponse>} */ adsGetPostsReach(params: MethodsProps.AdsGetPostsReachParams): Promise<Responses.AdsGetPostsReachResponse>; /** * Returns a reason of ad rejection for pre-moderation. * * @param {{ * account_id: (number), * ad_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetRejectionReasonResponse>} */ adsGetRejectionReason(params: MethodsProps.AdsGetRejectionReasonParams): Promise<Responses.AdsGetRejectionReasonResponse>; /** * Returns statistics of performance indicators for ads, campaigns, clients or the whole account. * * @param {{ * account_id: (number), * ids_type: (string), * ids: (string), * period: (string), * date_from: (string), * date_to: (string), * stats_fields: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetStatisticsResponse>} */ adsGetStatistics(params: MethodsProps.AdsGetStatisticsParams): Promise<Responses.AdsGetStatisticsResponse>; /** * Returns a set of auto-suggestions for various targeting parameters. * * @param {{ * section: (string), * ids: (string|undefined), * q: (string|undefined), * country: (number|undefined), * cities: (string|undefined), * lang: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetSuggestionsResponse>} */ adsGetSuggestions(params: MethodsProps.AdsGetSuggestionsParams): Promise<Responses.AdsGetSuggestionsResponse>; /** * Returns a list of target groups. * * @param {{ * account_id: (number), * client_id: (number|undefined), * extended: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetTargetGroupsResponse>} */ adsGetTargetGroups(params: MethodsProps.AdsGetTargetGroupsParams): Promise<Responses.AdsGetTargetGroupsResponse>; /** * Returns the size of targeting audience, and also recommended values for CPC and CPM. * * @param {{ * account_id: (number), * client_id: (number|undefined), * criteria: (string|undefined), * ad_id: (number|undefined), * ad_format: (number|undefined), * ad_platform: (string|undefined), * ad_platform_no_wall: (string|undefined), * ad_platform_no_ad_network: (string|undefined), * link_url: (string), * link_domain: (string|undefined), * need_precise: (boolean|undefined), * impressions_limit_period: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetTargetingStatsResponse>} */ adsGetTargetingStats(params: MethodsProps.AdsGetTargetingStatsParams): Promise<Responses.AdsGetTargetingStatsResponse>; /** * Returns URL to upload an ad photo to. * * @param {{ * ad_format: (number), * icon: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetUploadURLResponse>} */ adsGetUploadURL(params: MethodsProps.AdsGetUploadURLParams): Promise<Responses.AdsGetUploadURLResponse>; /** * Returns URL to upload an ad video to. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetVideoUploadURLResponse>} */ adsGetVideoUploadURL(params: MethodsProps.AdsGetVideoUploadURLParams): Promise<Responses.AdsGetVideoUploadURLResponse>; /** * Imports a list of advertiser's contacts to count VK registered users against the target group. * * @param {{ * account_id: (number), * client_id: (number|undefined), * target_group_id: (number), * contacts: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsImportTargetContactsResponse>} */ adsImportTargetContacts(params: MethodsProps.AdsImportTargetContactsParams): Promise<Responses.AdsImportTargetContactsResponse>; /** * Removes managers and/or supervisors from advertising account. * * @param {{ * account_id: (number), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsRemoveOfficeUsersResponse>} */ adsRemoveOfficeUsers(params: MethodsProps.AdsRemoveOfficeUsersParams): Promise<Responses.AdsRemoveOfficeUsersResponse>; /** * Edits ads. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsUpdateAdsResponse>} */ adsUpdateAds(params: MethodsProps.AdsUpdateAdsParams): Promise<Responses.AdsUpdateAdsResponse>; /** * Edits advertising campaigns. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsUpdateCampaignsResponse>} */ adsUpdateCampaigns(params: MethodsProps.AdsUpdateCampaignsParams): Promise<Responses.AdsUpdateCampaignsResponse>; /** * Edits clients of an advertising agency. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsUpdateClientsResponse>} */ adsUpdateClients(params: MethodsProps.AdsUpdateClientsParams): Promise<Responses.AdsUpdateClientsResponse>; /** * Adds managers and/or supervisors to advertising account. * * @param {{ * account_id: (number), * data: (Models.AdsUserSpecification[]), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsUpdateOfficeUsersResponse>} */ adsUpdateOfficeUsers(params: MethodsProps.AdsUpdateOfficeUsersParams): Promise<Responses.AdsUpdateOfficeUsersResponse>; /** * Edits a retarget group. * * @param {{ * account_id: (number), * client_id: (number|undefined), * target_group_id: (number), * name: (string), * domain: (string|undefined), * lifetime: (number), * target_pixel_id: (number|undefined), * target_pixel_rules: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ adsUpdateTargetGroup(params: MethodsProps.AdsUpdateTargetGroupParams): Promise<Responses.BaseOkResponse>; /** * undefined * * @param {{ * office_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetAdCategoriesResponse>} */ adswebGetAdCategories(params: MethodsProps.AdswebGetAdCategoriesParams): Promise<Responses.AdswebGetAdCategoriesResponse>; /** * undefined * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetAdUnitCodeResponse>} */ adswebGetAdUnitCode(params: MethodsProps.AdswebGetAdUnitCodeParams): Promise<Responses.AdswebGetAdUnitCodeResponse>; /** * undefined * * @param {{ * office_id: (number), * sites_ids: (string|undefined), * ad_units_ids: (string|undefined), * fields: (string|undefined), * limit: (number|undefined), * offset: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetAdUnitsResponse>} */ adswebGetAdUnits(params: MethodsProps.AdswebGetAdUnitsParams): Promise<Responses.AdswebGetAdUnitsResponse>; /** * undefined * * @param {{ * office_id: (number), * sites_ids: (string|undefined), * limit: (number|undefined), * offset: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetFraudHistoryResponse>} */ adswebGetFraudHistory(params: MethodsProps.AdswebGetFraudHistoryParams): Promise<Responses.AdswebGetFraudHistoryResponse>; /** * undefined * * @param {{ * office_id: (number), * sites_ids: (string|undefined), * fields: (string|undefined), * limit: (number|undefined), * offset: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetSitesResponse>} */ adswebGetSites(params: MethodsProps.AdswebGetSitesParams): Promise<Responses.AdswebGetSitesResponse>; /** * undefined * * @param {{ * office_id: (number), * ids_type: (string), * ids: (string), * period: (string), * date_from: (string), * date_to: (string), * fields: (string|undefined), * limit: (number|undefined), * page_id: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetStatisticsResponse>} */ adswebGetStatistics(params: MethodsProps.AdswebGetStatisticsParams): Promise<Responses.AdswebGetStatisticsResponse>; /** * Returns a URL for uploading a photo to the community collection for community app widgets * * @param {{ * image_type: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppWidgetsGetAppImageUploadServerResponse>} */ appWidgetsGetAppImageUploadServer(params: MethodsProps.AppWidgetsGetAppImageUploadServerParams): Promise<Responses.AppWidgetsGetAppImageUploadServerResponse>; /** * Returns an app collection of images for community app widgets * * @param {{ * offset: (number|undefined), * count: (number|undefined), * image_type: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppWidgetsGetAppImagesResponse>} */ appWidgetsGetAppImages(params: MethodsProps.AppWidgetsGetAppImagesParams): Promise<Responses.AppWidgetsGetAppImagesResponse>; /** * Returns a URL for uploading a photo to the community collection for community app widgets * * @param {{ * image_type: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppWidgetsGetGroupImageUploadServerResponse>} */ appWidgetsGetGroupImageUploadServer(params: MethodsProps.AppWidgetsGetGroupImageUploadServerParams): Promise<Responses.AppWidgetsGetGroupImageUploadServerResponse>; /** * Returns a community collection of images for community app widgets * * @param {{ * offset: (number|undefined), * count: (number|undefined), * image_type: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppWidgetsGetGroupImagesResponse>} */ appWidgetsGetGroupImages(params: MethodsProps.AppWidgetsGetGroupImagesParams): Promise<Responses.AppWidgetsGetGroupImagesResponse>; /** * Returns an image for community app widgets by its ID * * @param {{ * images: (string[]), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppWidgetsGetImagesByIdResponse>} */ appWidgetsGetImagesById(params: MethodsProps.AppWidgetsGetImagesByIdParams): Promise<Responses.AppWidgetsGetImagesByIdResponse>; /** * Allows to save image into app collection for community app widgets * * @param {{ * hash: (string), * image: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppWidgetsSaveAppImageResponse>} */ appWidgetsSaveAppImage(params: MethodsProps.AppWidgetsSaveAppImageParams): Promise<Responses.AppWidgetsSaveAppImageResponse>; /** * Allows to save image into community collection for community app widgets * * @param {{ * hash: (string), * image: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppWidgetsSaveGroupImageResponse>} */ appWidgetsSaveGroupImage(params: MethodsProps.AppWidgetsSaveGroupImageParams): Promise<Responses.AppWidgetsSaveGroupImageResponse>; /** * Allows to update community app widget * * @param {{ * code: (string), * type: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ appWidgetsUpdate(params: MethodsProps.AppWidgetsUpdateParams): Promise<Responses.BaseOkResponse>; /** * Deletes all request notifications from the current app. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ appsDeleteAppRequests(params: MethodsProps.AppsDeleteAppRequestsParams): Promise<Responses.BaseOkResponse>; /** * Returns applications data. * * @param {{ * app_id: (number|undefined), * app_ids: (string[]|undefined), * platform: (string|undefined), * extended: (boolean|undefined), * return_friends: (boolean|undefined), * fields: (Models.UsersFields[]|undefined), * name_case: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetResponse>} */ appsGet(params: MethodsProps.AppsGetParams): Promise<Responses.AppsGetResponse>; /** * Returns a list of applications (apps) available to users in the App Catalog. * * @param {{ * sort: (string|undefined), * offset: (number|undefined), * count: (number), * platform: (string|undefined), * extended: (boolean|undefined), * return_friends: (boolean|undefined), * fields: (Models.UsersFields[]|undefined), * name_case: (string|undefined), * q: (string|undefined), * genre_id: (number|undefined), * filter: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetCatalogResponse>} */ appsGetCatalog(params: MethodsProps.AppsGetCatalogParams): Promise<Responses.AppsGetCatalogResponse>; /** * Creates friends list for requests and invites in current app. * * @param {{ * extended: (boolean|undefined), * count: (number|undefined), * offset: (number|undefined), * type: (string|undefined), * fields: (Models.UsersFields[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetFriendsListResponse>} */ appsGetFriendsList(params: MethodsProps.AppsGetFriendsListParams): Promise<Responses.AppsGetFriendsListResponse>; /** * Returns players rating in the game. * * @param {{ * type: (string), * global: (boolean|undefined), * extended: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetLeaderboardResponse>} */ appsGetLeaderboard(params: MethodsProps.AppsGetLeaderboardParams): Promise<Responses.AppsGetLeaderboardResponse>; /** * Returns scopes for auth * * @param {{ * type: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetScopesResponse>} */ appsGetScopes(params: MethodsProps.AppsGetScopesParams): Promise<Responses.AppsGetScopesResponse>; /** * Returns user score in app * * @param {{ * user_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetScoreResponse>} */ appsGetScore(params: MethodsProps.AppsGetScoreParams): Promise<Responses.AppsGetScoreResponse>; /** * undefined * * @param {{ * promo_id: (number), * user_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseBoolResponse>} */ appsPromoHasActiveGift(params: MethodsProps.AppsPromoHasActiveGiftParams): Promise<Responses.BaseBoolResponse>; /** * undefined * * @param {{ * promo_id: (number), * user_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseBoolResponse>} */ appsPromoUseGift(params: MethodsProps.AppsPromoUseGiftParams): Promise<Responses.BaseBoolResponse>; /** * Sends a request to another user in an app that uses VK authorization. * * @param {{ * user_id: (number), * text: (string|undefined), * type: (string|undefined), * name: (string|undefined), * key: (string|undefined), * separate: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsSendRequestResponse>} */ appsSendRequest(params: MethodsProps.AppsSendRequestParams): Promise<Responses.AppsSendRequestResponse>; /** * 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. " * * @param {{ * phone: (string), * last_name: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AuthRestoreResponse>} */ authRestore(params: MethodsProps.AuthRestoreParams): Promise<Responses.AuthRestoreResponse>; /** * Creates a new topic on a community's discussion board. * * @param {{ * group_id: (number), * title: (string), * text: (string|undefined), * from_group: (boolean|undefined), * attachments: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BoardAddTopicResponse>} */ boardAddTopic(params: MethodsProps.BoardAddTopicParams): Promise<Responses.BoardAddTopicResponse>; /** * Closes a topic on a community's discussion board so that comments cannot be posted. * * @param {{ * group_id: (number), * topic_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardCloseTopic(params: MethodsProps.BoardCloseTopicParams): Promise<Responses.BaseOkResponse>; /** * Adds a comment on a topic on a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * message: (string|undefined), * attachments: (string[]|undefined), * from_group: (boolean|undefined), * sticker_id: (number|undefined), * guid: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BoardCreateCommentResponse>} */ boardCreateComment(params: MethodsProps.BoardCreateCommentParams): Promise<Responses.BoardCreateCommentResponse>; /** * Deletes a comment on a topic on a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * comment_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardDeleteComment(params: MethodsProps.BoardDeleteCommentParams): Promise<Responses.BaseOkResponse>; /** * Deletes a topic from a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardDeleteTopic(params: MethodsProps.BoardDeleteTopicParams): Promise<Responses.BaseOkResponse>; /** * Edits a comment on a topic on a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * comment_id: (number), * message: (string|undefined), * attachments: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardEditComment(params: MethodsProps.BoardEditCommentParams): Promise<Responses.BaseOkResponse>; /** * Edits the title of a topic on a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * title: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardEditTopic(params: MethodsProps.BoardEditTopicParams): Promise<Responses.BaseOkResponse>; /** * Pins a topic (fixes its place) to the top of a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardFixTopic(params: MethodsProps.BoardFixTopicParams): Promise<Responses.BaseOkResponse>; /** * Returns a list of comments on a topic on a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * need_likes: (boolean|undefined), * start_comment_id: (number|undefined), * offset: (number|undefined), * count: (number|undefined), * extended: (boolean|undefined), * sort: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BoardGetCommentsResponse>} */ boardGetComments(params: MethodsProps.BoardGetCommentsParams): Promise<Responses.BoardGetCommentsResponse>; /** * Returns a list of topics on a community's discussion board. * * @param {{ * group_id: (number), * topic_ids: (number[]|undefined), * order: (number|undefined), * offset: (number|undefined), * count: (number|undefined), * extended: (boolean|undefined), * preview: (number|undefined), * preview_length: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BoardGetTopicsResponse>} */ boardGetTopics(params: MethodsProps.BoardGetTopicsParams): Promise<Responses.BoardGetTopicsResponse>; /** * Re-opens a previously closed topic on a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardOpenTopic(params: MethodsProps.BoardOpenTopicParams): Promise<Responses.BaseOkResponse>; /** * Restores a comment deleted from a topic on a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * comment_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardRestoreComment(params: MethodsProps.BoardRestoreCommentParams): Promise<Responses.BaseOkResponse>; /** * Unpins a pinned topic from the top of a community's discussion board. * * @param {{ * group_id: (number), * topic_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ boardUnfixTopic(params: MethodsProps.BoardUnfixTopicParams): Promise<Responses.BaseOkResponse>; /** * Returns list of chairs on a specified faculty. * * @param {{ * faculty_id: (number), * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetChairsResponse>} */ databaseGetChairs(params: MethodsProps.DatabaseGetChairsParams): Promise<Responses.DatabaseGetChairsResponse>; /** * Returns a list of cities. * * @param {{ * country_id: (number), * region_id: (number|undefined), * q: (string|undefined), * need_all: (boolean|undefined), * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetCitiesResponse>} */ databaseGetCities(params: MethodsProps.DatabaseGetCitiesParams): Promise<Responses.DatabaseGetCitiesResponse>; /** * Returns information about cities by their IDs. * * @param {{ * city_ids: (number[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetCitiesByIdResponse>} */ databaseGetCitiesById(params: MethodsProps.DatabaseGetCitiesByIdParams): Promise<Responses.DatabaseGetCitiesByIdResponse>; /** * Returns a list of countries. * * @param {{ * need_all: (boolean|undefined), * code: (string|undefined), * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetCountriesResponse>} */ databaseGetCountries(params: MethodsProps.DatabaseGetCountriesParams): Promise<Responses.DatabaseGetCountriesResponse>; /** * Returns information about countries by their IDs. * * @param {{ * country_ids: (number[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetCountriesByIdResponse>} */ databaseGetCountriesById(params: MethodsProps.DatabaseGetCountriesByIdParams): Promise<Responses.DatabaseGetCountriesByIdResponse>; /** * Returns a list of faculties (i.e., university departments). * * @param {{ * university_id: (number), * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetFacultiesResponse>} */ databaseGetFaculties(params: MethodsProps.DatabaseGetFacultiesParams): Promise<Responses.DatabaseGetFacultiesResponse>; /** * Get metro stations by city * * @param {{ * city_id: (number), * offset: (number|undefined), * count: (number|undefined), * extended: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetMetroStationsResponse>} */ databaseGetMetroStations(params: MethodsProps.DatabaseGetMetroStationsParams): Promise<Responses.DatabaseGetMetroStationsResponse>; /** * Get metro station by his id * * @param {{ * station_ids: (number[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetMetroStationsByIdResponse>} */ databaseGetMetroStationsById(params: MethodsProps.DatabaseGetMetroStationsByIdParams): Promise<Responses.DatabaseGetMetroStationsByIdResponse>; /** * Returns a list of regions. * * @param {{ * country_id: (number), * q: (string|undefined), * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetRegionsResponse>} */ databaseGetRegions(params: MethodsProps.DatabaseGetRegionsParams): Promise<Responses.DatabaseGetRegionsResponse>; /** * Returns a list of school classes specified for the country. * * @param {{ * country_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetSchoolClassesResponse>} */ databaseGetSchoolClasses(params: MethodsProps.DatabaseGetSchoolClassesParams): Promise<Responses.DatabaseGetSchoolClassesResponse>; /** * Returns a list of schools. * * @param {{ * q: (string|undefined), * city_id: (number), * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetSchoolsResponse>} */ databaseGetSchools(params: MethodsProps.DatabaseGetSchoolsParams): Promise<Responses.DatabaseGetSchoolsResponse>; /** * Returns a list of higher education institutions. * * @param {{ * q: (string|undefined), * country_id: (number|undefined), * city_id: (number|undefined), * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DatabaseGetUniversitiesResponse>} */ databaseGetUniversities(params: MethodsProps.DatabaseGetUniversitiesParams): Promise<Responses.DatabaseGetUniversitiesResponse>; /** * Copies a document to a user's or community's document list. * * @param {{ * owner_id: (number), * doc_id: (number), * access_key: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.DocsAddResponse>} */ docsAdd(params: MethodsProps.DocsAddParams): Promise<Responses.DocsAddResponse>; /** * Deletes a user or community document. * * @param {{ * owner_id: (number), * doc_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ docsDelete(params: MethodsProps.DocsDeleteParams): Promise<Responses.BaseOkResponse>; /** * Edits a document. * * @param {{ * owner_id: (number), * doc_id: (number), * title: (string|undefined), * tags: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ docsEdit(params: MethodsProps.DocsEditParams): Promise<Responses.BaseOkResponse>; /** * Returns detailed information about user or community documents.