UNPKG

node-vk-sdk

Version:

VK API SDK for Node.js

1,441 lines (1,440 loc) 274 kB
import {BaseVKApi} from "../api/BaseVKApi" import * as MethodsProps from "./MethodsProps" import * as Responses from "./Responses" export class VKApi extends BaseVKApi { /** * undefined * * @param {{ * owner_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ public async accountBan(params: MethodsProps.AccountBanParams): Promise<Responses.BaseOkResponse> { return super.call("account.ban", params) } /** * 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>} */ public async accountChangePassword(params: MethodsProps.AccountChangePasswordParams): Promise<Responses.AccountChangePasswordResponse> { return super.call("account.changePassword", params) } /** * 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>} */ public async accountGetActiveOffers(params: MethodsProps.AccountGetActiveOffersParams): Promise<Responses.AccountGetActiveOffersResponse> { return super.call("account.getActiveOffers", params) } /** * Gets settings of the user in this application. * * @param {{ * user_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetAppPermissionsResponse>} */ public async accountGetAppPermissions(params: MethodsProps.AccountGetAppPermissionsParams): Promise<Responses.AccountGetAppPermissionsResponse> { return super.call("account.getAppPermissions", params) } /** * Returns a user's blacklist. * * @param {{ * offset: (number|undefined), * count: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetBannedResponse>} */ public async accountGetBanned(params: MethodsProps.AccountGetBannedParams): Promise<Responses.AccountGetBannedResponse> { return super.call("account.getBanned", params) } /** * Returns non-null values of user counters. * * @param {{ * filter: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetCountersResponse>} */ public async accountGetCounters(params: MethodsProps.AccountGetCountersParams): Promise<Responses.AccountGetCountersResponse> { return super.call("account.getCounters", params) } /** * Returns current account info. * * @param {{ * fields: (string[]|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetInfoResponse>} */ public async accountGetInfo(params: MethodsProps.AccountGetInfoParams): Promise<Responses.AccountGetInfoResponse> { return super.call("account.getInfo", params) } /** * Returns the current account info. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetProfileInfoResponse>} */ public async accountGetProfileInfo(params: MethodsProps.AccountGetProfileInfoParams): Promise<Responses.AccountGetProfileInfoResponse> { return super.call("account.getProfileInfo", params) } /** * Gets settings of push notifications. * * @param {{ * device_id: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AccountGetPushSettingsResponse>} */ public async accountGetPushSettings(params: MethodsProps.AccountGetPushSettingsParams): Promise<Responses.AccountGetPushSettingsResponse> { return super.call("account.getPushSettings", params) } /** * 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>} */ public async accountRegisterDevice(params: MethodsProps.AccountRegisterDeviceParams): Promise<Responses.BaseOkResponse> { return super.call("account.registerDevice", params) } /** * 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>} */ public async accountSaveProfileInfo(params: MethodsProps.AccountSaveProfileInfoParams): Promise<Responses.AccountSaveProfileInfoResponse> { return super.call("account.saveProfileInfo", params) } /** * Allows to edit the current account info. * * @param {{ * name: (string|undefined), * value: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ public async accountSetInfo(params: MethodsProps.AccountSetInfoParams): Promise<Responses.BaseOkResponse> { return super.call("account.setInfo", params) } /** * 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>} */ public async accountSetNameInMenu(params: MethodsProps.AccountSetNameInMenuParams): Promise<Responses.BaseOkResponse> { return super.call("account.setNameInMenu", params) } /** * Marks a current user as offline. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ public async accountSetOffline(params: MethodsProps.AccountSetOfflineParams): Promise<Responses.BaseOkResponse> { return super.call("account.setOffline", params) } /** * Marks the current user as online for 15 minutes. * * @param {{ * voip: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ public async accountSetOnline(params: MethodsProps.AccountSetOnlineParams): Promise<Responses.BaseOkResponse> { return super.call("account.setOnline", params) } /** * 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>} */ public async accountSetPushSettings(params: MethodsProps.AccountSetPushSettingsParams): Promise<Responses.BaseOkResponse> { return super.call("account.setPushSettings", params) } /** * 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>} */ public async accountSetSilenceMode(params: MethodsProps.AccountSetSilenceModeParams): Promise<Responses.BaseOkResponse> { return super.call("account.setSilenceMode", params) } /** * undefined * * @param {{ * owner_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ public async accountUnban(params: MethodsProps.AccountUnbanParams): Promise<Responses.BaseOkResponse> { return super.call("account.unban", params) } /** * Unsubscribes a device from push notifications. * * @param {{ * device_id: (string|undefined), * sandbox: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ public async accountUnregisterDevice(params: MethodsProps.AccountUnregisterDeviceParams): Promise<Responses.BaseOkResponse> { return super.call("account.unregisterDevice", params) } /** * Adds managers and/or supervisors to advertising account. * * @param {{ * account_id: (number), * data: (Models.AdsUserSpecificationCutted[]), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsAddOfficeUsersResponse>} */ public async adsAddOfficeUsers(params: MethodsProps.AdsAddOfficeUsersParams): Promise<Responses.AdsAddOfficeUsersResponse> { return super.call("ads.addOfficeUsers", params) } /** * 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>} */ public async adsCheckLink(params: MethodsProps.AdsCheckLinkParams): Promise<Responses.AdsCheckLinkResponse> { return super.call("ads.checkLink", params) } /** * Creates ads. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsCreateAdsResponse>} */ public async adsCreateAds(params: MethodsProps.AdsCreateAdsParams): Promise<Responses.AdsCreateAdsResponse> { return super.call("ads.createAds", params) } /** * Creates advertising campaigns. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsCreateCampaignsResponse>} */ public async adsCreateCampaigns(params: MethodsProps.AdsCreateCampaignsParams): Promise<Responses.AdsCreateCampaignsResponse> { return super.call("ads.createCampaigns", params) } /** * Creates clients of an advertising agency. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsCreateClientsResponse>} */ public async adsCreateClients(params: MethodsProps.AdsCreateClientsParams): Promise<Responses.AdsCreateClientsResponse> { return super.call("ads.createClients", params) } /** * 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>} */ public async adsCreateTargetGroup(params: MethodsProps.AdsCreateTargetGroupParams): Promise<Responses.AdsCreateTargetGroupResponse> { return super.call("ads.createTargetGroup", params) } /** * Archives ads. * * @param {{ * account_id: (number), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsDeleteAdsResponse>} */ public async adsDeleteAds(params: MethodsProps.AdsDeleteAdsParams): Promise<Responses.AdsDeleteAdsResponse> { return super.call("ads.deleteAds", params) } /** * Archives advertising campaigns. * * @param {{ * account_id: (number), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsDeleteCampaignsResponse>} */ public async adsDeleteCampaigns(params: MethodsProps.AdsDeleteCampaignsParams): Promise<Responses.AdsDeleteCampaignsResponse> { return super.call("ads.deleteCampaigns", params) } /** * Archives clients of an advertising agency. * * @param {{ * account_id: (number), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsDeleteClientsResponse>} */ public async adsDeleteClients(params: MethodsProps.AdsDeleteClientsParams): Promise<Responses.AdsDeleteClientsResponse> { return super.call("ads.deleteClients", params) } /** * 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>} */ public async adsDeleteTargetGroup(params: MethodsProps.AdsDeleteTargetGroupParams): Promise<Responses.BaseOkResponse> { return super.call("ads.deleteTargetGroup", params) } /** * Returns a list of advertising accounts. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetAccountsResponse>} */ public async adsGetAccounts(params: MethodsProps.AdsGetAccountsParams): Promise<Responses.AdsGetAccountsResponse> { return super.call("ads.getAccounts", params) } /** * 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>} */ public async adsGetAds(params: MethodsProps.AdsGetAdsParams): Promise<Responses.AdsGetAdsResponse> { return super.call("ads.getAds", params) } /** * 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>} */ public async adsGetAdsLayout(params: MethodsProps.AdsGetAdsLayoutParams): Promise<Responses.AdsGetAdsLayoutResponse> { return super.call("ads.getAdsLayout", params) } /** * 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>} */ public async adsGetAdsTargeting(params: MethodsProps.AdsGetAdsTargetingParams): Promise<Responses.AdsGetAdsTargetingResponse> { return super.call("ads.getAdsTargeting", params) } /** * Returns current budget of the advertising account. * * @param {{ * account_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetBudgetResponse>} */ public async adsGetBudget(params: MethodsProps.AdsGetBudgetParams): Promise<Responses.AdsGetBudgetResponse> { return super.call("ads.getBudget", params) } /** * 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>} */ public async adsGetCampaigns(params: MethodsProps.AdsGetCampaignsParams): Promise<Responses.AdsGetCampaignsResponse> { return super.call("ads.getCampaigns", params) } /** * Returns a list of possible ad categories. * * @param {{ * lang: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetCategoriesResponse>} */ public async adsGetCategories(params: MethodsProps.AdsGetCategoriesParams): Promise<Responses.AdsGetCategoriesResponse> { return super.call("ads.getCategories", params) } /** * Returns a list of advertising agency's clients. * * @param {{ * account_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetClientsResponse>} */ public async adsGetClients(params: MethodsProps.AdsGetClientsParams): Promise<Responses.AdsGetClientsResponse> { return super.call("ads.getClients", params) } /** * 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>} */ public async adsGetDemographics(params: MethodsProps.AdsGetDemographicsParams): Promise<Responses.AdsGetDemographicsResponse> { return super.call("ads.getDemographics", params) } /** * 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>} */ public async adsGetFloodStats(params: MethodsProps.AdsGetFloodStatsParams): Promise<Responses.AdsGetFloodStatsResponse> { return super.call("ads.getFloodStats", params) } /** * 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>} */ public async adsGetLookalikeRequests(params: MethodsProps.AdsGetLookalikeRequestsParams): Promise<Responses.AdsGetLookalikeRequestsResponse> { return super.call("ads.getLookalikeRequests", params) } /** * undefined * * @param {{ * artist_name: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetMusiciansResponse>} */ public async adsGetMusicians(params: MethodsProps.AdsGetMusiciansParams): Promise<Responses.AdsGetMusiciansResponse> { return super.call("ads.getMusicians", params) } /** * Returns a list of managers and supervisors of advertising account. * * @param {{ * account_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetOfficeUsersResponse>} */ public async adsGetOfficeUsers(params: MethodsProps.AdsGetOfficeUsersParams): Promise<Responses.AdsGetOfficeUsersResponse> { return super.call("ads.getOfficeUsers", params) } /** * 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>} */ public async adsGetPostsReach(params: MethodsProps.AdsGetPostsReachParams): Promise<Responses.AdsGetPostsReachResponse> { return super.call("ads.getPostsReach", params) } /** * 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>} */ public async adsGetRejectionReason(params: MethodsProps.AdsGetRejectionReasonParams): Promise<Responses.AdsGetRejectionReasonResponse> { return super.call("ads.getRejectionReason", params) } /** * 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>} */ public async adsGetStatistics(params: MethodsProps.AdsGetStatisticsParams): Promise<Responses.AdsGetStatisticsResponse> { return super.call("ads.getStatistics", params) } /** * 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>} */ public async adsGetSuggestions(params: MethodsProps.AdsGetSuggestionsParams): Promise<Responses.AdsGetSuggestionsResponse> { return super.call("ads.getSuggestions", params) } /** * 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>} */ public async adsGetTargetGroups(params: MethodsProps.AdsGetTargetGroupsParams): Promise<Responses.AdsGetTargetGroupsResponse> { return super.call("ads.getTargetGroups", params) } /** * 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>} */ public async adsGetTargetingStats(params: MethodsProps.AdsGetTargetingStatsParams): Promise<Responses.AdsGetTargetingStatsResponse> { return super.call("ads.getTargetingStats", params) } /** * Returns URL to upload an ad photo to. * * @param {{ * ad_format: (number), * icon: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetUploadURLResponse>} */ public async adsGetUploadURL(params: MethodsProps.AdsGetUploadURLParams): Promise<Responses.AdsGetUploadURLResponse> { return super.call("ads.getUploadURL", params) } /** * Returns URL to upload an ad video to. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsGetVideoUploadURLResponse>} */ public async adsGetVideoUploadURL(params: MethodsProps.AdsGetVideoUploadURLParams): Promise<Responses.AdsGetVideoUploadURLResponse> { return super.call("ads.getVideoUploadURL", params) } /** * 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>} */ public async adsImportTargetContacts(params: MethodsProps.AdsImportTargetContactsParams): Promise<Responses.AdsImportTargetContactsResponse> { return super.call("ads.importTargetContacts", params) } /** * Removes managers and/or supervisors from advertising account. * * @param {{ * account_id: (number), * ids: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsRemoveOfficeUsersResponse>} */ public async adsRemoveOfficeUsers(params: MethodsProps.AdsRemoveOfficeUsersParams): Promise<Responses.AdsRemoveOfficeUsersResponse> { return super.call("ads.removeOfficeUsers", params) } /** * Edits ads. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsUpdateAdsResponse>} */ public async adsUpdateAds(params: MethodsProps.AdsUpdateAdsParams): Promise<Responses.AdsUpdateAdsResponse> { return super.call("ads.updateAds", params) } /** * Edits advertising campaigns. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsUpdateCampaignsResponse>} */ public async adsUpdateCampaigns(params: MethodsProps.AdsUpdateCampaignsParams): Promise<Responses.AdsUpdateCampaignsResponse> { return super.call("ads.updateCampaigns", params) } /** * Edits clients of an advertising agency. * * @param {{ * account_id: (number), * data: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsUpdateClientsResponse>} */ public async adsUpdateClients(params: MethodsProps.AdsUpdateClientsParams): Promise<Responses.AdsUpdateClientsResponse> { return super.call("ads.updateClients", params) } /** * Adds managers and/or supervisors to advertising account. * * @param {{ * account_id: (number), * data: (Models.AdsUserSpecification[]), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdsUpdateOfficeUsersResponse>} */ public async adsUpdateOfficeUsers(params: MethodsProps.AdsUpdateOfficeUsersParams): Promise<Responses.AdsUpdateOfficeUsersResponse> { return super.call("ads.updateOfficeUsers", params) } /** * 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>} */ public async adsUpdateTargetGroup(params: MethodsProps.AdsUpdateTargetGroupParams): Promise<Responses.BaseOkResponse> { return super.call("ads.updateTargetGroup", params) } /** * undefined * * @param {{ * office_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetAdCategoriesResponse>} */ public async adswebGetAdCategories(params: MethodsProps.AdswebGetAdCategoriesParams): Promise<Responses.AdswebGetAdCategoriesResponse> { return super.call("adsweb.getAdCategories", params) } /** * undefined * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetAdUnitCodeResponse>} */ public async adswebGetAdUnitCode(params: MethodsProps.AdswebGetAdUnitCodeParams): Promise<Responses.AdswebGetAdUnitCodeResponse> { return super.call("adsweb.getAdUnitCode", params) } /** * 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>} */ public async adswebGetAdUnits(params: MethodsProps.AdswebGetAdUnitsParams): Promise<Responses.AdswebGetAdUnitsResponse> { return super.call("adsweb.getAdUnits", params) } /** * undefined * * @param {{ * office_id: (number), * sites_ids: (string|undefined), * limit: (number|undefined), * offset: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AdswebGetFraudHistoryResponse>} */ public async adswebGetFraudHistory(params: MethodsProps.AdswebGetFraudHistoryParams): Promise<Responses.AdswebGetFraudHistoryResponse> { return super.call("adsweb.getFraudHistory", params) } /** * 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>} */ public async adswebGetSites(params: MethodsProps.AdswebGetSitesParams): Promise<Responses.AdswebGetSitesResponse> { return super.call("adsweb.getSites", params) } /** * 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>} */ public async adswebGetStatistics(params: MethodsProps.AdswebGetStatisticsParams): Promise<Responses.AdswebGetStatisticsResponse> { return super.call("adsweb.getStatistics", params) } /** * 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>} */ public async appWidgetsGetAppImageUploadServer(params: MethodsProps.AppWidgetsGetAppImageUploadServerParams): Promise<Responses.AppWidgetsGetAppImageUploadServerResponse> { return super.call("appWidgets.getAppImageUploadServer", params) } /** * 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>} */ public async appWidgetsGetAppImages(params: MethodsProps.AppWidgetsGetAppImagesParams): Promise<Responses.AppWidgetsGetAppImagesResponse> { return super.call("appWidgets.getAppImages", params) } /** * 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>} */ public async appWidgetsGetGroupImageUploadServer(params: MethodsProps.AppWidgetsGetGroupImageUploadServerParams): Promise<Responses.AppWidgetsGetGroupImageUploadServerResponse> { return super.call("appWidgets.getGroupImageUploadServer", params) } /** * 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>} */ public async appWidgetsGetGroupImages(params: MethodsProps.AppWidgetsGetGroupImagesParams): Promise<Responses.AppWidgetsGetGroupImagesResponse> { return super.call("appWidgets.getGroupImages", params) } /** * Returns an image for community app widgets by its ID * * @param {{ * images: (string[]), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppWidgetsGetImagesByIdResponse>} */ public async appWidgetsGetImagesById(params: MethodsProps.AppWidgetsGetImagesByIdParams): Promise<Responses.AppWidgetsGetImagesByIdResponse> { return super.call("appWidgets.getImagesById", params) } /** * 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>} */ public async appWidgetsSaveAppImage(params: MethodsProps.AppWidgetsSaveAppImageParams): Promise<Responses.AppWidgetsSaveAppImageResponse> { return super.call("appWidgets.saveAppImage", params) } /** * 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>} */ public async appWidgetsSaveGroupImage(params: MethodsProps.AppWidgetsSaveGroupImageParams): Promise<Responses.AppWidgetsSaveGroupImageResponse> { return super.call("appWidgets.saveGroupImage", params) } /** * Allows to update community app widget * * @param {{ * code: (string), * type: (string), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ public async appWidgetsUpdate(params: MethodsProps.AppWidgetsUpdateParams): Promise<Responses.BaseOkResponse> { return super.call("appWidgets.update", params) } /** * Deletes all request notifications from the current app. * * @param {{ * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseOkResponse>} */ public async appsDeleteAppRequests(params: MethodsProps.AppsDeleteAppRequestsParams): Promise<Responses.BaseOkResponse> { return super.call("apps.deleteAppRequests", params) } /** * 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>} */ public async appsGet(params: MethodsProps.AppsGetParams): Promise<Responses.AppsGetResponse> { return super.call("apps.get", params) } /** * 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>} */ public async appsGetCatalog(params: MethodsProps.AppsGetCatalogParams): Promise<Responses.AppsGetCatalogResponse> { return super.call("apps.getCatalog", params) } /** * 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>} */ public async appsGetFriendsList(params: MethodsProps.AppsGetFriendsListParams): Promise<Responses.AppsGetFriendsListResponse> { return super.call("apps.getFriendsList", params) } /** * Returns players rating in the game. * * @param {{ * type: (string), * global: (boolean|undefined), * extended: (boolean|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetLeaderboardResponse>} */ public async appsGetLeaderboard(params: MethodsProps.AppsGetLeaderboardParams): Promise<Responses.AppsGetLeaderboardResponse> { return super.call("apps.getLeaderboard", params) } /** * Returns scopes for auth * * @param {{ * type: (string|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetScopesResponse>} */ public async appsGetScopes(params: MethodsProps.AppsGetScopesParams): Promise<Responses.AppsGetScopesResponse> { return super.call("apps.getScopes", params) } /** * Returns user score in app * * @param {{ * user_id: (number), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.AppsGetScoreResponse>} */ public async appsGetScore(params: MethodsProps.AppsGetScoreParams): Promise<Responses.AppsGetScoreResponse> { return super.call("apps.getScore", params) } /** * undefined * * @param {{ * promo_id: (number), * user_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseBoolResponse>} */ public async appsPromoHasActiveGift(params: MethodsProps.AppsPromoHasActiveGiftParams): Promise<Responses.BaseBoolResponse> { return super.call("apps.promoHasActiveGift", params) } /** * undefined * * @param {{ * promo_id: (number), * user_id: (number|undefined), * access_token: (string|undefined) * }} params * * @returns {Promise<Responses.BaseBoolResponse>} */ public async appsPromoUseGift(params: MethodsProps.AppsPromoUseGiftParams): Promise<Responses.BaseBoolResponse> { return super.call("apps.promoUseGift", params) } /** * 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>} */ public async appsSendRequest(params: MethodsProps.AppsSendRequestParams): Promise<Responses.AppsSendRequestResponse> { return super.call("apps.sendRequest", params) } /** * 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>} */ public async authRestore(params: MethodsProps.AuthRestoreParams): Promise<Responses.AuthRestoreResponse> { return super.call("auth.restore", params) } /** * 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>} */ public async boardAddTopic(params: MethodsProps.BoardAddTopicParams): Promise<Responses.BoardAddTopicResponse> { return super.call("board.addTopic", params) } /** * 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>} */ public async boardCloseTopic(params: MethodsProps.BoardCloseTopicParams): Promise<Responses.BaseOkResponse> { return super.call("board.closeTopic", params) } /** * 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>} */ public async boardCreateComment(params: MethodsProps.BoardCreateCommentParams): Promise<Responses.BoardCreateCommentResponse> { return super.call("board.createComment", params) } /** * 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>} */ public async boardDeleteComment(params: MethodsProps.BoardDeleteCommentParams): Promise<Responses.BaseOkResponse> { return super.call("board.deleteComment", params) } /** * 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>} */ public async boardDeleteTopic(params: MethodsProps.BoardDeleteTopicParams): Promise<Responses.BaseOkResponse> { return super.call("board.deleteTopic", params) } /** * 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>} */ public async boardEditComment(params: MethodsProps.BoardEditCommentParams): Promise<Responses.BaseOkResponse> { return super.call("board.editComment", params) } /** * 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>} */ public async boardEditTopic(params: MethodsProps.BoardEditTopicParams): Promise<Responses.BaseOkResponse> { return super.call("board.editTopic", params) } /** * 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>} */ public async boardFixTopic(params: MethodsProps.BoardFixTopicParams): Promise<Responses.BaseOkResponse> { return super.call("board.fixTopic", params) } /** * 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>} */ public async boardGetComments(params: MethodsProps.BoardGetCommentsParams): Promise<Responses.BoardGetCommentsResponse> { return super.call("board.getComments", params) } /** * 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>} */ public async boardGetTopics(params: MethodsProps.BoardGetTopicsParams): Promise<Responses.BoardGetTopicsResponse> { return super.call("board.getTopics", params) } /** * 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>} */ public async boardOpenTopic(params: MethodsProps.BoardOpenTopicParams): Promise<Responses.BaseOkResponse> { return super.call("board.openTopic", params) } /** * 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>} */ public async boardRestoreComment(params: MethodsProps.BoardRestoreCommentParams): Promise<Responses.BaseOkResponse> { return sup