vk-io
Version:
Modern VK API SDK for Node.js
1,783 lines • 214 kB
TypeScript
import * as Objects from "./objects";
export interface AccountBanParams {
owner_id?: number;
[key: string]: any;
}
export interface AccountChangePasswordParams {
/**
* Session id received after the [vk.com/dev/auth.restore|auth.restore] method is executed. (If the password is changed right after the access was restored)
*/
restore_sid?: string;
/**
* Hash received after a successful OAuth authorization with a code got by SMS. (If the password is changed right after the access was restored)
*/
change_password_hash?: string;
/**
* Current user password.
*/
old_password?: string;
/**
* New password that will be set as a current
*/
new_password: string;
[key: string]: any;
}
export interface AccountGetActiveOffersParams {
/**
* Number of results to return.
*/
count?: number;
offset?: number;
[key: string]: any;
}
export interface AccountGetAppPermissionsParams {
/**
* User ID whose settings information shall be got. By default: current user.
*/
user_id?: number;
[key: string]: any;
}
export interface AccountGetBannedParams {
/**
* Offset needed to return a specific subset of results.
*/
offset?: number;
/**
* Number of results to return.
*/
count?: number;
[key: string]: any;
}
export interface AccountGetCountersParams {
filter?: string[] | string;
[key: string]: any;
}
export interface AccountGetInfoParams {
fields?: ("country" | "https_required" | "own_posts_default" | "no_wall_replies" | "intro" | "lang" | "audio_autoplay")[] | ("country" | "https_required" | "own_posts_default" | "no_wall_replies" | "intro" | "lang" | "audio_autoplay");
[key: string]: any;
}
export interface AccountGetProfileInfoParams {
[key: string]: any;
}
export interface AccountGetPushSettingsParams {
/**
* Unique device ID.
*/
device_id?: string;
[key: string]: any;
}
export interface AccountRegisterDeviceParams {
/**
* Device token used to send notifications. (for mpns, the token shall be URL for sending of notifications)
*/
token: string;
/**
* String name of device model.
*/
device_model?: string;
/**
* Device year.
*/
device_year?: number;
/**
* Unique device ID.
*/
device_id: string;
/**
* String version of device operating system.
*/
system_version?: string;
/**
* Push settings in a [vk.com/dev/push_settings|special format].
*/
settings?: string;
sandbox?: boolean | number;
[key: string]: any;
}
export interface AccountSaveProfileInfoParams {
/**
* User first name.
*/
first_name?: string;
/**
* User last name.
*/
last_name?: string;
/**
* User maiden name (female only)
*/
maiden_name?: string;
/**
* User screen name.
*/
screen_name?: string;
/**
* ID of the name change request to be canceled. If this parameter is sent, all the others are ignored.
*/
cancel_request_id?: number;
/**
* User sex. Possible values: , * '1' - female,, * '2' - male.
*/
sex?: 0 | 1 | 2;
/**
* User relationship status. Possible values: , * '1' - single,, * '2' - in a relationship,, * '3' - engaged,, * '4' - married,, * '5' - it's complicated,, * '6' - actively searching,, * '7' - in love,, * '0' - not specified.
*/
relation?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
/**
* ID of the relationship partner.
*/
relation_partner_id?: number;
/**
* User birth date, format: DD.MM.YYYY.
*/
bdate?: string;
/**
* Birth date visibility. Returned values: , * '1' - show birth date,, * '2' - show only month and day,, * '0' - hide birth date.
*/
bdate_visibility?: 0 | 1 | 2;
/**
* User home town.
*/
home_town?: string;
/**
* User country.
*/
country_id?: number;
/**
* User city.
*/
city_id?: number;
/**
* Status text.
*/
status?: string;
[key: string]: any;
}
export interface AccountSetInfoParams {
/**
* Setting name.
*/
name?: "audio_autoplay" | "intro" | "no_wall_replies" | "own_posts_default";
/**
* Setting value.
*/
value?: string;
[key: string]: any;
}
export interface AccountSetOfflineParams {
[key: string]: any;
}
export interface AccountSetOnlineParams {
/**
* '1' if videocalls are available for current device.
*/
voip?: boolean | number;
[key: string]: any;
}
export interface AccountSetPushSettingsParams {
/**
* Unique device ID.
*/
device_id: string;
/**
* Push settings in a [vk.com/dev/push_settings|special format].
*/
settings?: string;
/**
* Notification key.
*/
key?: string;
value?: string[] | string;
[key: string]: any;
}
export interface AccountSetSilenceModeParams {
/**
* Unique device ID.
*/
device_id?: string;
/**
* Time in seconds for what notifications should be disabled. '-1' to disable forever.
*/
time?: number;
/**
* Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
*/
peer_id?: number;
/**
* '1' - to enable sound in this dialog, '0' - to disable sound. Only if 'peer_id' contains user or community ID.
*/
sound?: number;
[key: string]: any;
}
export interface AccountUnbanParams {
owner_id?: number;
[key: string]: any;
}
export interface AccountUnregisterDeviceParams {
/**
* Unique device ID.
*/
device_id?: string;
sandbox?: boolean | number;
[key: string]: any;
}
export interface AdsAddOfficeUsersParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array of objects that describe added managers. Description of 'user_specification' objects see below.
*/
data: string;
[key: string]: any;
}
export interface AdsCheckLinkParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Object type: *'community' - community,, *'post' - community post,, *'application' - VK application,, *'video' - video,, *'site' - external site.
*/
link_type: "application" | "community" | "mobile_app" | "post" | "site" | "user" | "user_post" | "video";
/**
* Object URL.
*/
link_url: string;
/**
* Campaign ID
*/
campaign_id?: number;
[key: string]: any;
}
export interface AdsCreateAdsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array of objects that describe created ads. Description of 'ad_specification' objects see below.
*/
data: string;
[key: string]: any;
}
export interface AdsCreateCampaignsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array of objects that describe created campaigns. Description of 'campaign_specification' objects see below.
*/
data: string;
[key: string]: any;
}
export interface AdsCreateClientsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array of objects that describe created campaigns. Description of 'client_specification' objects see below.
*/
data: string;
[key: string]: any;
}
export interface AdsCreateLookalikeRequestParams {
account_id: number;
client_id?: number;
source_type: string;
retargeting_group_id?: number;
[key: string]: any;
}
export interface AdsCreateTargetGroupParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* 'Only for advertising agencies.', ID of the client with the advertising account where the group will be created.
*/
client_id?: number;
/**
* Name of the target group - a string up to 64 characters long.
*/
name: string;
/**
* 'For groups with auditory created with pixel code only.', , Number of days after that users will be automatically removed from the group.
*/
lifetime: number;
target_pixel_id?: number;
target_pixel_rules?: string;
[key: string]: any;
}
export interface AdsCreateTargetPixelParams {
account_id: number;
client_id?: number;
name: string;
domain?: string;
category_id: number;
[key: string]: any;
}
export interface AdsDeleteAdsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array with ad IDs.
*/
ids: string;
[key: string]: any;
}
export interface AdsDeleteCampaignsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array with IDs of deleted campaigns.
*/
ids: string;
[key: string]: any;
}
export interface AdsDeleteClientsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array with IDs of deleted clients.
*/
ids: string;
[key: string]: any;
}
export interface AdsDeleteTargetGroupParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* 'Only for advertising agencies.' , ID of the client with the advertising account where the group will be created.
*/
client_id?: number;
/**
* Group ID.
*/
target_group_id: number;
[key: string]: any;
}
export interface AdsDeleteTargetPixelParams {
account_id: number;
client_id?: number;
target_pixel_id: number;
[key: string]: any;
}
export interface AdsGetAccountsParams {
[key: string]: any;
}
export interface AdsGetAdsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Filter by ads. Serialized JSON array with ad IDs. If the parameter is null, all ads will be shown.
*/
ad_ids?: string;
/**
* Filter by advertising campaigns. Serialized JSON array with campaign IDs. If the parameter is null, ads of all campaigns will be shown.
*/
campaign_ids?: string;
/**
* 'Available and required for advertising agencies.' ID of the client ads are retrieved from.
*/
client_id?: number;
/**
* Flag that specifies whether archived ads shall be shown: *0 - show only active ads,, *1 - show all ads.
*/
include_deleted?: boolean | number;
/**
* Flag that specifies whether to show only archived ads: *0 - show all ads,, *1 - show only archived ads. Available when include_deleted flag is *1
*/
only_deleted?: boolean | number;
/**
* Limit of number of returned ads. Used only if ad_ids parameter is null, and 'campaign_ids' parameter contains ID of only one campaign.
*/
limit?: number;
/**
* Offset. Used in the same cases as 'limit' parameter.
*/
offset?: number;
[key: string]: any;
}
export interface AdsGetAdsLayoutParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* 'For advertising agencies.' ID of the client ads are retrieved from.
*/
client_id?: number;
/**
* Flag that specifies whether archived ads shall be shown. *0 - show only active ads,, *1 - show all ads.
*/
include_deleted?: boolean | number;
/**
* Flag that specifies whether to show only archived ads: *0 - show all ads,, *1 - show only archived ads. Available when include_deleted flag is *1
*/
only_deleted?: boolean | number;
/**
* Filter by advertising campaigns. Serialized JSON array with campaign IDs. If the parameter is null, ads of all campaigns will be shown.
*/
campaign_ids?: string;
/**
* Filter by ads. Serialized JSON array with ad IDs. If the parameter is null, all ads will be shown.
*/
ad_ids?: string;
/**
* Limit of number of returned ads. Used only if 'ad_ids' parameter is null, and 'campaign_ids' parameter contains ID of only one campaign.
*/
limit?: number;
/**
* Offset. Used in the same cases as 'limit' parameter.
*/
offset?: number;
[key: string]: any;
}
export interface AdsGetAdsTargetingParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Filter by ads. Serialized JSON array with ad IDs. If the parameter is null, all ads will be shown.
*/
ad_ids?: string;
/**
* Filter by advertising campaigns. Serialized JSON array with campaign IDs. If the parameter is null, ads of all campaigns will be shown.
*/
campaign_ids?: string;
/**
* 'For advertising agencies.' ID of the client ads are retrieved from.
*/
client_id?: number;
/**
* flag that specifies whether archived ads shall be shown: *0 - show only active ads,, *1 - show all ads.
*/
include_deleted?: boolean | number;
/**
* Limit of number of returned ads. Used only if 'ad_ids' parameter is null, and 'campaign_ids' parameter contains ID of only one campaign.
*/
limit?: number;
/**
* Offset needed to return a specific subset of results.
*/
offset?: number;
[key: string]: any;
}
export interface AdsGetBudgetParams {
/**
* Advertising account ID.
*/
account_id: number;
[key: string]: any;
}
export interface AdsGetCampaignsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* 'For advertising agencies'. ID of the client advertising campaigns are retrieved from.
*/
client_id?: number;
/**
* Flag that specifies whether archived ads shall be shown. *0 - show only active campaigns,, *1 - show all campaigns.
*/
include_deleted?: boolean | number;
/**
* Filter of advertising campaigns to show. Serialized JSON array with campaign IDs. Only campaigns that exist in 'campaign_ids' and belong to the specified advertising account will be shown. If the parameter is null, all campaigns will be shown.
*/
campaign_ids?: string;
fields?: ("ads_count")[] | ("ads_count");
[key: string]: any;
}
export interface AdsGetCategoriesParams {
/**
* Language. The full list of supported languages is [vk.com/dev/api_requests|here].
*/
lang?: string;
[key: string]: any;
}
export interface AdsGetClientsParams {
/**
* Advertising account ID.
*/
account_id: number;
[key: string]: any;
}
export interface AdsGetDemographicsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Type of requested objects listed in 'ids' parameter: *ad - ads,, *campaign - campaigns.
*/
ids_type: "ad" | "campaign";
/**
* IDs requested ads or campaigns, separated with a comma, depending on the value set in 'ids_type'. Maximum 2000 objects.
*/
ids: string;
/**
* Data grouping by dates: *day - statistics by days,, *month - statistics by months,, *overall - overall statistics. 'date_from' and 'date_to' parameters set temporary limits.
*/
period: "day" | "month" | "overall";
/**
* Date to show statistics from. For different value of 'period' different date format is used: *day: YYYY-MM-DD, example: 2011-09-27 - September 27, 2011, **0 - day it was created on,, *month: YYYY-MM, example: 2011-09 - September 2011, **0 - month it was created in,, *overall: 0.
*/
date_from: string;
/**
* Date to show statistics to. For different value of 'period' different date format is used: *day: YYYY-MM-DD, example: 2011-09-27 - September 27, 2011, **0 - current day,, *month: YYYY-MM, example: 2011-09 - September 2011, **0 - current month,, *overall: 0.
*/
date_to: string;
[key: string]: any;
}
export interface AdsGetFloodStatsParams {
/**
* Advertising account ID.
*/
account_id: number;
[key: string]: any;
}
export interface AdsGetLookalikeRequestsParams {
account_id: number;
client_id?: number;
requests_ids?: string;
offset?: number;
limit?: number;
sort_by?: string;
[key: string]: any;
}
export interface AdsGetMusiciansParams {
artist_name: string;
[key: string]: any;
}
export interface AdsGetMusiciansByIdsParams {
ids?: number[] | number;
[key: string]: any;
}
export interface AdsGetOfficeUsersParams {
/**
* Advertising account ID.
*/
account_id: number;
[key: string]: any;
}
export interface AdsGetPostsReachParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Type of requested objects listed in 'ids' parameter: *ad - ads,, *campaign - campaigns.
*/
ids_type: "ad" | "campaign";
/**
* IDs requested ads or campaigns, separated with a comma, depending on the value set in 'ids_type'. Maximum 100 objects.
*/
ids: string;
[key: string]: any;
}
export interface AdsGetRejectionReasonParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Ad ID.
*/
ad_id: number;
[key: string]: any;
}
export interface AdsGetStatisticsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Type of requested objects listed in 'ids' parameter: *ad - ads,, *campaign - campaigns,, *client - clients,, *office - account.
*/
ids_type: "ad" | "campaign" | "client" | "office";
/**
* IDs requested ads, campaigns, clients or account, separated with a comma, depending on the value set in 'ids_type'. Maximum 2000 objects.
*/
ids: string;
/**
* Data grouping by dates: *day - statistics by days,, *month - statistics by months,, *overall - overall statistics. 'date_from' and 'date_to' parameters set temporary limits.
*/
period: "day" | "month" | "overall" | "week" | "year";
/**
* Date to show statistics from. For different value of 'period' different date format is used: *day: YYYY-MM-DD, example: 2011-09-27 - September 27, 2011, **0 - day it was created on,, *month: YYYY-MM, example: 2011-09 - September 2011, **0 - month it was created in,, *overall: 0.
*/
date_from: string;
/**
* Date to show statistics to. For different value of 'period' different date format is used: *day: YYYY-MM-DD, example: 2011-09-27 - September 27, 2011, **0 - current day,, *month: YYYY-MM, example: 2011-09 - September 2011, **0 - current month,, *overall: 0.
*/
date_to: string;
stats_fields?: ("views_times")[] | ("views_times");
[key: string]: any;
}
export interface AdsGetSuggestionsParams {
/**
* Section, suggestions are retrieved in. Available values: *countries - request of a list of countries. If q is not set or blank, a short list of countries is shown. Otherwise, a full list of countries is shown. *regions - requested list of regions. 'country' parameter is required. *cities - requested list of cities. 'country' parameter is required. *districts - requested list of districts. 'cities' parameter is required. *stations - requested list of subway stations. 'cities' parameter is required. *streets - requested list of streets. 'cities' parameter is required. *schools - requested list of educational organizations. 'cities' parameter is required. *interests - requested list of interests. *positions - requested list of positions (professions). *group_types - requested list of group types. *religions - requested list of religious commitments. *browsers - requested list of browsers and mobile devices.
*/
section: "browsers" | "cities" | "cities_regions" | "countries" | "districts" | "group_types" | "interest_categories" | "interest_categories_v2" | "interests" | "operators" | "positions" | "price_lists" | "regions" | "religions" | "schools" | "stations" | "streets" | "user_browsers" | "user_devices" | "user_operating_systems" | "user_os";
/**
* Objects IDs separated by commas. If the parameter is passed, 'q, country, cities' should not be passed.
*/
ids?: string;
/**
* Filter-line of the request (for countries, regions, cities, streets, schools, interests, positions).
*/
q?: string;
/**
* ID of the country objects are searched in.
*/
country?: number;
/**
* IDs of cities where objects are searched in, separated with a comma.
*/
cities?: string;
lang?: Objects.BaseLang;
[key: string]: any;
}
export interface AdsGetTargetGroupsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* 'Only for advertising agencies.', ID of the client with the advertising account where the group will be created.
*/
client_id?: number;
/**
* '1' - to return pixel code.
*/
extended?: boolean | number;
[key: string]: any;
}
export interface AdsGetTargetPixelsParams {
account_id: number;
client_id?: number;
[key: string]: any;
}
export interface AdsGetTargetingStatsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON object that describes targeting parameters. Description of 'criteria' object see below.
*/
criteria?: string;
/**
* ID of an ad which targeting parameters shall be analyzed.
*/
ad_id?: number;
/**
* Ad format. Possible values: *'1' - image and text,, *'2' - big image,, *'3' - exclusive format,, *'4' - community, square image,, *'7' - special app format,, *'8' - special community format,, *'9' - post in community,, *'10' - app board.
*/
ad_format?: 1 | 2 | 4 | 7 | 10 | 6 | 9 | 11;
/**
* Platforms to use for ad showing. Possible values: (for 'ad_format' = '1'), *'0' - VK and partner sites,, *'1' - VK only. (for 'ad_format' = '9'), *'all' - all platforms,, *'desktop' - desktop version,, *'mobile' - mobile version and apps.
*/
ad_platform?: string;
/**
* URL for the advertised object.
*/
link_url: string;
/**
* Domain of the advertised object.
*/
link_domain?: string;
/**
* Additionally return recommended cpc and cpm to reach 5,10..95 percents of audience.
*/
need_precise?: boolean | number;
/**
* Impressions limit period in seconds, must be a multiple of 86400(day)
*/
impressions_limit_period?: number;
client_id?: number;
ad_platform_no_wall?: string;
ad_platform_no_ad_network?: string;
publisher_platforms?: string;
[key: string]: any;
}
export interface AdsGetUploadURLParams {
/**
* Ad format: *1 - image and text,, *2 - big image,, *3 - exclusive format,, *4 - community, square image,, *7 - special app format.
*/
ad_format: 1 | 2 | 4 | 7 | 10 | 11;
icon?: number;
[key: string]: any;
}
export interface AdsGetVideoUploadURLParams {
[key: string]: any;
}
export interface AdsImportTargetContactsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* 'Only for advertising agencies.' , ID of the client with the advertising account where the group will be created.
*/
client_id?: number;
/**
* Target group ID.
*/
target_group_id: number;
/**
* List of phone numbers, emails or user IDs separated with a comma.
*/
contacts: string;
[key: string]: any;
}
export interface AdsRemoveOfficeUsersParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array with IDs of deleted managers.
*/
ids: string;
[key: string]: any;
}
export interface AdsRemoveTargetContactsParams {
account_id: number;
client_id?: number;
target_group_id: number;
contacts: string;
[key: string]: any;
}
export interface AdsSaveLookalikeRequestResultParams {
account_id: number;
client_id?: number;
request_id: number;
level: number;
[key: string]: any;
}
export interface AdsShareTargetGroupParams {
account_id: number;
client_id?: number;
target_group_id: number;
share_with_client_id?: number;
[key: string]: any;
}
export interface AdsUpdateAdsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array of objects that describe changes in ads. Description of 'ad_edit_specification' objects see below.
*/
data: string;
[key: string]: any;
}
export interface AdsUpdateCampaignsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array of objects that describe changes in campaigns. Description of 'campaign_mod' objects see below.
*/
data: string;
[key: string]: any;
}
export interface AdsUpdateClientsParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array of objects that describe changes in clients. Description of 'client_mod' objects see below.
*/
data: string;
[key: string]: any;
}
export interface AdsUpdateOfficeUsersParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* Serialized JSON array of objects that describe added managers. Description of 'user_specification' objects see below.
*/
data: string;
[key: string]: any;
}
export interface AdsUpdateTargetGroupParams {
/**
* Advertising account ID.
*/
account_id: number;
/**
* 'Only for advertising agencies.' , ID of the client with the advertising account where the group will be created.
*/
client_id?: number;
/**
* Group ID.
*/
target_group_id: number;
/**
* New name of the target group - a string up to 64 characters long.
*/
name: string;
/**
* Domain of the site where user accounting code will be placed.
*/
domain?: string;
/**
* 'Only for the groups that get audience from sites with user accounting code.', Time in days when users added to a retarget group will be automatically excluded from it. '0' - automatic exclusion is off.
*/
lifetime: number;
target_pixel_id?: number;
target_pixel_rules?: string;
[key: string]: any;
}
export interface AdsUpdateTargetPixelParams {
account_id: number;
client_id?: number;
target_pixel_id: number;
name: string;
domain?: string;
category_id: number;
[key: string]: any;
}
export interface AdswebGetAdCategoriesParams {
office_id: number;
[key: string]: any;
}
export interface AdswebGetAdUnitCodeParams {
[key: string]: any;
}
export interface AdswebGetAdUnitsParams {
office_id: number;
sites_ids?: string;
ad_units_ids?: string;
fields?: string;
limit?: number;
offset?: number;
[key: string]: any;
}
export interface AdswebGetFraudHistoryParams {
office_id: number;
sites_ids?: string;
limit?: number;
offset?: number;
[key: string]: any;
}
export interface AdswebGetSitesParams {
office_id: number;
sites_ids?: string;
fields?: string;
limit?: number;
offset?: number;
[key: string]: any;
}
export interface AdswebGetStatisticsParams {
office_id: number;
ids_type: string;
ids: string;
period: string;
date_from: string;
date_to: string;
fields?: string;
limit?: number;
page_id?: string;
[key: string]: any;
}
export interface AppsAddUsersToTestingGroupParams {
user_ids?: number[] | number;
group_id: number;
[key: string]: any;
}
export interface AppsDeleteAppRequestsParams {
[key: string]: any;
}
export interface AppsGetParams {
/**
* Application ID
*/
app_id?: number;
/**
* platform. Possible values: *'ios' - iOS,, *'android' - Android,, *'winphone' - Windows Phone,, *'web' - приложения на vk.com. By default: 'web'.
*/
platform?: "android" | "ios" | "web";
app_ids?: number[] | number;
extended?: boolean | number;
return_friends?: boolean | number;
fields?: Objects.UsersFields[];
name_case?: Objects.BaseNameCase;
app_fields?: Objects.AppsAppFields[];
[key: string]: any;
}
export interface AppsGetCatalogParams {
/**
* Sort order: 'popular_today' - popular for one day (default), 'visitors' - by visitors number , 'create_date' - by creation date, 'growth_rate' - by growth rate, 'popular_week' - popular for one week
*/
sort?: "create_date" | "growth_rate" | "popular" | "popular_today" | "popular_week" | "visitors";
/**
* Offset required to return a specific subset of apps.
*/
offset?: number;
/**
* Number of apps to return.
*/
count?: number;
/**
* '1' - to return additional fields 'screenshots', 'MAU', 'catalog_position', and 'international'. If set, 'count' must be less than or equal to '100'. '0' - not to return additional fields (default).
*/
extended?: boolean | number;
/**
* Search query string.
*/
q?: string;
/**
* 'installed' - to return list of installed apps (only for mobile platform).
*/
filter?: "favorite" | "featured" | "installed" | "new";
platform?: string;
return_friends?: boolean | number;
fields?: Objects.UsersFields[];
name_case?: string;
genre_id?: number;
[key: string]: any;
}
export interface AppsGetFriendsListParams {
/**
* List size.
*/
count?: number;
/**
* List type. Possible values: * 'invite' - available for invites (don't play the game),, * 'request' - available for request (play the game). By default: 'invite'.
*/
type?: "invite" | "request";
/**
* Search query string (e.g., 'Vasya Babich').
*/
query?: string;
extended?: boolean | number;
offset?: number;
fields?: Objects.UsersFields[];
[key: string]: any;
}
export interface AppsGetLastUploadedVersionParams {
[key: string]: any;
}
export interface AppsGetLeaderboardParams {
/**
* Leaderboard type. Possible values: *'level' - by level,, *'points' - by mission points,, *'score' - by score ().
*/
type: "level" | "points" | "score";
/**
* Rating type. Possible values: *'1' - global rating among all players,, *'0' - rating among user friends.
*/
global?: boolean | number;
/**
* 1 - to return additional info about users
*/
extended?: boolean | number;
[key: string]: any;
}
export interface AppsGetMiniAppPoliciesParams {
/**
* Mini App ID
*/
app_id: number;
[key: string]: any;
}
export interface AppsGetScopesParams {
type?: "group" | "user";
[key: string]: any;
}
export interface AppsGetScoreParams {
user_id?: number;
[key: string]: any;
}
export interface AppsGetTestingGroupsParams {
group_id?: number;
[key: string]: any;
}
export interface AppsIsNotificationsAllowedParams {
user_id?: number;
[key: string]: any;
}
export interface AppsPromoHasActiveGiftParams {
/**
* Id of game promo action
*/
promo_id: number;
user_id?: number;
[key: string]: any;
}
export interface AppsPromoUseGiftParams {
/**
* Id of game promo action
*/
promo_id: number;
user_id?: number;
[key: string]: any;
}
export interface AppsRemoveTestingGroupParams {
group_id: number;
[key: string]: any;
}
export interface AppsRemoveUsersFromTestingGroupsParams {
user_ids?: number[] | number;
[key: string]: any;
}
export interface AppsSendRequestParams {
/**
* id of the user to send a request
*/
user_id: number;
/**
* request text
*/
text?: string;
/**
* request type. Values: 'invite' - if the request is sent to a user who does not have the app installed,, 'request' - if a user has already installed the app
*/
type?: "invite" | "request";
/**
* special string key to be sent with the request
*/
key?: string;
name?: string;
separate?: boolean | number;
[key: string]: any;
}
export interface AppsUpdateMetaForTestingGroupParams {
group_id?: number;
webview: string;
name: string;
platforms?: ("mobile" | "web" | "mvk")[] | ("mobile" | "web" | "mvk");
user_ids?: number[] | number;
[key: string]: any;
}
export interface AppWidgetsGetAppImageUploadServerParams {
image_type: "160x160" | "160x240" | "24x24" | "50x50" | "510x128";
[key: string]: any;
}
export interface AppWidgetsGetAppImagesParams {
/**
* Offset needed to return a specific subset of images.
*/
offset?: number;
/**
* Maximum count of results.
*/
count?: number;
image_type?: "160x160" | "160x240" | "24x24" | "50x50" | "510x128";
[key: string]: any;
}
export interface AppWidgetsGetGroupImageUploadServerParams {
image_type: "160x160" | "160x240" | "24x24" | "50x50" | "510x128";
[key: string]: any;
}
export interface AppWidgetsGetGroupImagesParams {
/**
* Offset needed to return a specific subset of images.
*/
offset?: number;
/**
* Maximum count of results.
*/
count?: number;
image_type?: "160x160" | "160x240" | "24x24" | "50x50" | "510x128";
[key: string]: any;
}
export interface AppWidgetsGetImagesByIdParams {
images?: string[] | string;
[key: string]: any;
}
export interface AppWidgetsSaveAppImageParams {
/**
* Parameter returned when photo is uploaded to server
*/
hash: string;
/**
* Parameter returned when photo is uploaded to server
*/
image: string;
[key: string]: any;
}
export interface AppWidgetsSaveGroupImageParams {
/**
* Parameter returned when photo is uploaded to server
*/
hash: string;
/**
* Parameter returned when photo is uploaded to server
*/
image: string;
[key: string]: any;
}
export interface AppWidgetsUpdateParams {
code: string;
type: "compact_list" | "cover_list" | "donation" | "list" | "match" | "matches" | "table" | "text" | "tiles";
[key: string]: any;
}
export interface AsrCheckStatusParams {
/**
* ID of ASR task in UUID format.
*/
task_id: string;
[key: string]: any;
}
export interface AsrGetUploadUrlParams {
[key: string]: any;
}
export interface AsrProcessParams {
/**
* This parameter is a JSON response returned from [vk.com/dev/upload_files_2|file uploading server].
*/
audio: string;
/**
* Which model to use for recognition. `neutral` -- general purpose (interviews, TV shows, etc.), `spontaneous` -- for NSFW audios (slang, profanity, etc.)
*/
model: "neutral" | "spontaneous";
[key: string]: any;
}
export interface AuthRestoreParams {
/**
* User phone number.
*/
phone: string;
/**
* User last name.
*/
last_name: string;
[key: string]: any;
}
export interface BoardAddTopicParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic title.
*/
title: string;
/**
* Text of the topic.
*/
text?: string;
/**
* For a community: '1' - to post the topic as by the community, '0' - to post the topic as by the user (default)
*/
from_group?: boolean | number;
attachments?: string[] | string;
[key: string]: any;
}
export interface BoardCloseTopicParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
[key: string]: any;
}
export interface BoardCreateCommentParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* ID of the topic to be commented on.
*/
topic_id: number;
/**
* (Required if 'attachments' is not set.) Text of the comment.
*/
message?: string;
/**
* '1' - to post the comment as by the community, '0' - to post the comment as by the user (default)
*/
from_group?: boolean | number;
/**
* Sticker ID.
*/
sticker_id?: number;
/**
* Unique identifier to avoid repeated comments.
*/
guid?: string;
attachments?: string[] | string;
[key: string]: any;
}
export interface BoardDeleteCommentParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
/**
* Comment ID.
*/
comment_id: number;
[key: string]: any;
}
export interface BoardDeleteTopicParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
[key: string]: any;
}
export interface BoardEditCommentParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
/**
* ID of the comment on the topic.
*/
comment_id: number;
/**
* (Required if 'attachments' is not set). New comment text.
*/
message?: string;
attachments?: string[] | string;
[key: string]: any;
}
export interface BoardEditTopicParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
/**
* New title of the topic.
*/
title: string;
[key: string]: any;
}
export interface BoardFixTopicParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
[key: string]: any;
}
export interface BoardGetCommentsParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
/**
* '1' - to return the 'likes' field, '0' - not to return the 'likes' field (default)
*/
need_likes?: boolean | number;
/**
* Offset needed to return a specific subset of comments.
*/
offset?: number;
/**
* Number of comments to return.
*/
count?: number;
/**
* '1' - to return information about users who posted comments, '0' - to return no additional fields (default)
*/
extended?: boolean | number;
/**
* Sort order: 'asc' - by creation date in chronological order, 'desc' - by creation date in reverse chronological order,
*/
sort?: "asc" | "desc";
start_comment_id?: number;
[key: string]: any;
}
export interface BoardGetTopicsParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Sort order: '1' - by date updated in reverse chronological order. '2' - by date created in reverse chronological order. '-1' - by date updated in chronological order. '-2' - by date created in chronological order. If no sort order is specified, topics are returned in the order specified by the group administrator. Pinned topics are returned first, regardless of the sorting.
*/
order?: 1 | 2 | -1 | -2 | 0;
/**
* Offset needed to return a specific subset of topics.
*/
offset?: number;
/**
* Number of topics to return.
*/
count?: number;
/**
* '1' - to return information about users who created topics or who posted there last, '0' - to return no additional fields (default)
*/
extended?: boolean | number;
/**
* '1' - to return the first comment in each topic,, '2' - to return the last comment in each topic,, '0' - to return no comments. By default: '0'.
*/
preview?: 1 | 2 | 0;
/**
* Number of characters after which to truncate the previewed comment. To preview the full comment, specify '0'.
*/
preview_length?: number;
topic_ids?: number[] | number;
[key: string]: any;
}
export interface BoardOpenTopicParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
[key: string]: any;
}
export interface BoardRestoreCommentParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
/**
* Comment ID.
*/
comment_id: number;
[key: string]: any;
}
export interface BoardUnfixTopicParams {
/**
* ID of the community that owns the discussion board.
*/
group_id: number;
/**
* Topic ID.
*/
topic_id: number;
[key: string]: any;
}
export interface BugtrackerAddCompanyGroupsMembersParams {
company_id: number;
user_ids?: number[] | number;
company_group_ids?: number[] | number;
[key: string]: any;
}
export interface BugtrackerAddCompanyMembersParams {
user_ids?: number[] | number;
company_id: number;
[key: string]: any;
}
export interface BugtrackerChangeBugreportStatusParams {
bugreport_id: number;
status?: number;
comment?: string;
from_statuses?: number[] | number;
not_in_statuses?: number[] | number;
[key: string]: any;
}
export interface BugtrackerCreateCommentParams {
bugreport_id: number;
text?: string;
hidden?: boolean | number;
force?: boolean | number;
[key: string]: any;
}
export interface BugtrackerGetCompanyGroupMembersParams {
company_id: number;
company_group_id: number;
count?: number;
offset?: number;
filter_name?: string;
extended?: boolean | number;
fields?: Objects.BaseUserGroupFields[];
[key: string]: any;
}
export interface BugtrackerGetCompanyMembersParams {
company_id: number;
count?: number;
offset?: number;
filter_name?: string;
filter_role?: 0 | 1;
filter_not_group?: number;
filter_member_ids?: number[] | number;
extended?: boolean | number;
fields?: Objects.BaseUserGroupFields[];
extra?: boolean | number;
[key: string]: any;
}
export interface BugtrackerGetDownloadVersionUrlParams {
product_id: number;
version_id: number;
ttl?: number;
[key: string]: any;
}
export interface BugtrackerGetProductBuildUploadServerParams {
product_id: number;
[key: string]: any;
}
export interface BugtrackerRemoveCompanyGroupMemberParams {
company_id: number;
user_id: number;
company_group_id: number;
[key: string]: any;
}
export interface BugtrackerRemoveCompanyMemberParams {
user_id: number;
company_id: number;
[key: string]: any;
}
export interface BugtrackerSaveProductVersionParams {
product_id?: number;
version_id?: number;
title: string;
release_notes?: string;
visible?: boolean | number;
set_rft?: boolean | number;
[key: string]: any;
}
export interface BugtrackerSetCompanyMemberRoleParams {
user_id: number;
company_id: number;
role: 0 | 1;
[key: string]: any;
}
export interface BugtrackerSetProductIsOverParams {
product_id: number;
is_over?: boolean | number;
[key: string]: any;
}
export interface CallsForceFinishParams {
call_id: string;
[key: string]: any;
}
export interface CallsStartParams {
group_id?: number;
[key: string]: any;
}
export interface DatabaseGetChairsParams {
/**
* id of the faculty to get chairs from
*/
faculty_id: number;
/**
* offset required to get a certain subset of chairs
*/
offset?: number;
/**
* amount of chairs to get
*/
count?: number;
[key: string]: any;
}
export interface DatabaseGetCitiesParams {
/**
* Country ID.
*/
country_id?: number;
/**
* Region ID.
*/
region_id?: number;
/**
* Search query.
*/
q?: string;
/**
* '1' - to return all cities in the country, '0' - to return major cities in the country (default),
*/
need_all?: boolean | number;
/**
* Offset needed to return a specific subset of cities.
*/
offset?: number;
/**
* Number of cities to return.
*/
count?: number;
[key: string]: any;
}
export interface DatabaseGetCitiesByIdParams {
city_ids?: number[] | number;
[key: string]: any;
}
export interface DatabaseGetCountriesParams {
/**
* '1' - to return a full list of all countries, '0' - to return a list of countries near the current user's country (default).
*/
need_all?: boolean | number;
/**
* Country codes in [vk.com/dev/country_codes|ISO 3166-1 alpha-2] standard.
*/
code?: string;
/**
* Offset needed to return a specific subset of countries.
*/
offset?: number;
/**
* Number of countries to return.
*/
count?: number;
[key: string]: any;
}
export interface DatabaseGetCountriesByIdParams {
country_ids?: number[] | number;
[key: string]: any;
}
export interface DatabaseGetFacultiesParams {
/**
* University ID.
*/
university_id: number;
/**
* Offset needed to return a specific subset of faculties.
*/
offset?: number;
/**
* Number of faculties to return.
*/
count?: number;
[key: string]: any;
}
export interface DatabaseGetMetroStationsParams {
city_id: number;
offset?: number;
count?: number;
extended?: boolean | number;
[key: string]: any;
}
export interface DatabaseGetMetroStationsByIdParams {
station_ids?: number[] | number;
[key: string]: any;
}
export interface DatabaseGetRegionsParams {
/**
* Country ID, received in [vk.com/dev/database.getCountries|database.getCountries] method.
*/
country_id: number;
/**
* Search query.
*/
q?: string;
/**
* Offset needed to return specific subset of regions.
*/
offset?: number;
/**
* Number of regions to return.
*/
count?: number;
[key: string]: any;
}
export interface DatabaseGetSchoolClassesParams {
/**
* Country ID.
*/
country_id?: number;
[key: string]: any;
}
export interface DatabaseGetSchoolsParams {
/**
* Search query.
*/
q?: string;
/**
* City ID.
*/
city_id: number;
/**
* Offset needed to return a specific subset of schools.
*/
offset?: number;
/**
* Number of schools to return.
*/
count?: number;
[key: string]: any;
}
export interface DatabaseGetUniversitiesParams {
/**
* Search query.
*/
q?: string;
/**
* Country ID.
*/
country_id?: number;
/**
* City ID.
*/
city_id?: number;
/**
* Offset needed to return a specific subset of universities.
*/
offset?: number;
/**
* Number of universities to return.
*/
count?: number;
[key: string]: any;
}
export interface DocsAddParams {
/**
* ID of the user or community that owns the document. Use a negative value to designate a community ID.
*/
owner_id: number;
/**
* Document ID.
*/
doc_id: number;
/**
* Access key. This parameter is required if 'access_key' was returned with the document's data.
*/
access_key?: string;
[key: string]: any;
}
export interface DocsDeleteParams {
/**
* ID of the user or community that owns the document. Use a negative value to designate a community ID.
*/
owner_id: number;
/**
* Document ID.
*/
doc_id: number;
[key: string]: any;
}
export interface DocsEditParams {
/**
* User ID or community ID. Use a negative value to designate a community ID.
*/
owner_id?: number;
/**
* Document ID.
*/
doc_id: number;
/**
* Document title.
*/
title: string;
tags?: string[] | string;
[key: string]: any;
}
export interface DocsGetParams {
/**
* Number of documents to return. By default, all documents.
*/
count?: number;
/**
* Offset needed to return a specific subset of documents.
*/
offset?: number;
/**
* ID of the user or community that owns the documents. Use a negative value to designate a community ID.
*/
owner_id?: number;
type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
return_tags?: boolean | number;
[key: string]: any;
}
export interface DocsGetByIdParams {
docs?: string[] | string;
return_tags?: boolean | number;
[key: string]: any;
}
export interface DocsGetMessagesUploadServerParams {
/**
* Document type.
*/
type?: "audio_message" | "doc" | "graffiti";
/**
* Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
*/
peer_id?: number;
[key: string]: any;
}
export interface DocsGetTypesParams {
/**
* ID of the user or community that owns the documents. Use a negative value to designate a community ID.
*/
owner_id?: number;
[key: string]: any;
}
export interface DocsGetUploadServerParams {
/**
* Community ID (if the document will be uploaded to the community).
*/
group_id?: number;
[key: string]: any;
}
export interface DocsGetWallUploadServerParams {
/**
* Community ID (if the document will be uploaded to the community).
*/
group_id?: number;
[key: string]: any;
}
export interface DocsSaveParams {
/**
* This parameter is returned when the file is [vk.com/dev/upload_files_2|uploaded to the server].
*/
file: string;
/**
* Document title.
*/
title?: string;
/**
* Document tags.
*/
tags?: string;
return_tags?: boolean | number;
[key: string]: any;
}
export interface DocsSearchParams {
/**
* Search query string.
*/
q?: string;
/**
* Number of results