node-vk-sdk
Version:
VK API SDK for Node.js
3,243 lines (3,086 loc) • 250 kB
text/typescript
export interface AccountAccountCounters {
/**
* New app requests number
*/
app_requests: number,
/**
* New events number
*/
events: number,
/**
* New faves number
*/
faves: number,
/**
* New friends requests number
*/
friends: number,
/**
* New friends suggestions number
*/
friends_suggestions: number,
/**
* New friends recommendations number
*/
friends_recommendations: number,
/**
* New gifts number
*/
gifts: number,
/**
* New groups number
*/
groups: number,
/**
*
*/
menu_discover_badge: number,
/**
*
*/
menu_clips_badge: number,
/**
* New messages number
*/
messages: number,
/**
* New memories number
*/
memories: number,
/**
* New notes number
*/
notes: number,
/**
* New notifications number
*/
notifications: number,
/**
* New photo tags number
*/
photos: number,
/**
* New sdk number
*/
sdk: number
}
export interface AccountInfo {
/**
*
*/
wishlists_ae_promo_banner_show: BaseBoolInt,
/**
* Two factor authentication is enabled
*/
twoFaRequired: BaseBoolInt,
/**
* Country code
*/
country: string,
/**
* Information whether HTTPS-only is enabled
*/
https_required: BaseBoolInt,
/**
* Information whether user has been processed intro
*/
intro: BaseBoolInt,
/**
*
*/
show_vk_apps_intro: boolean,
/**
* Ads slot id for MyTarget
*/
mini_apps_ads_slot_id: number,
/**
*
*/
qr_promotion: number,
/**
*
*/
link_redirects: any,
/**
* Language ID
*/
lang: number,
/**
* Information whether wall comments should be hidden
*/
no_wall_replies: BaseBoolInt,
/**
* Information whether only owners posts should be shown
*/
own_posts_default: BaseBoolInt,
/**
*
*/
subscriptions: number[]
}
export interface AccountNameRequest {
/**
* First name in request
*/
first_name: string,
/**
* Request ID needed to cancel the request
*/
id: number,
/**
* Last name in request
*/
last_name: string,
/**
*
*/
status: AccountNameRequestStatus,
/**
* Text to display to user
*/
lang: string,
/**
* href for link in lang field
*/
link_href: string,
/**
* label to display for link in lang field
*/
link_label: string
}
export type AccountNameRequestStatus = string
export interface AccountOffer {
/**
* Offer description
*/
description: string,
/**
* Offer ID
*/
id: number,
/**
* URL of the preview image
*/
img: string,
/**
* Instruction how to process the offer
*/
instruction: string,
/**
* Instruction how to process the offer (HTML format)
*/
instruction_html: string,
/**
* Offer price
*/
price: number,
/**
* Offer short description
*/
short_description: string,
/**
* Offer tag
*/
tag: string,
/**
* Offer title
*/
title: string,
/**
* Currency amount
*/
currency_amount: number,
/**
* Link id
*/
link_id: number,
/**
* Link type
*/
link_type: string
}
export interface AccountPushConversations {
/**
* Items count
*/
count: number,
/**
*
*/
items: AccountPushConversationsItem[]
}
export interface AccountPushConversationsItem {
/**
* Time until that notifications are disabled in seconds
*/
disabled_until: number,
/**
* Peer ID
*/
peer_id: number,
/**
* Information whether the sound are enabled
*/
sound: BaseBoolInt
}
export interface AccountPushParams {
/**
*
*/
msg: AccountPushParamsMode[],
/**
*
*/
chat: AccountPushParamsMode[],
/**
*
*/
like: AccountPushParamsSettings[],
/**
*
*/
repost: AccountPushParamsSettings[],
/**
*
*/
comment: AccountPushParamsSettings[],
/**
*
*/
mention: AccountPushParamsSettings[],
/**
*
*/
reply: AccountPushParamsOnoff[],
/**
*
*/
new_post: AccountPushParamsOnoff[],
/**
*
*/
wall_post: AccountPushParamsOnoff[],
/**
*
*/
wall_publish: AccountPushParamsOnoff[],
/**
*
*/
friend: AccountPushParamsOnoff[],
/**
*
*/
friend_found: AccountPushParamsOnoff[],
/**
*
*/
friend_accepted: AccountPushParamsOnoff[],
/**
*
*/
group_invite: AccountPushParamsOnoff[],
/**
*
*/
group_accepted: AccountPushParamsOnoff[],
/**
*
*/
birthday: AccountPushParamsOnoff[],
/**
*
*/
event_soon: AccountPushParamsOnoff[],
/**
*
*/
app_request: AccountPushParamsOnoff[],
/**
*
*/
sdk_open: AccountPushParamsOnoff[]
}
export type AccountPushParamsMode = string
export type AccountPushParamsOnoff = string
export type AccountPushParamsSettings = string
export interface AccountPushSettings {
/**
* Information whether notifications are disabled
*/
disabled: BaseBoolInt,
/**
* Time until that notifications are disabled in Unixtime
*/
disabled_until: number,
/**
*
*/
settings: AccountPushParams,
/**
*
*/
conversations: AccountPushConversations
}
export interface AccountUserSettings {
/**
* Returns if a profile is deleted or blocked
*/
deactivated: string,
/**
* User first name
*/
first_name: string,
/**
* Returns if a profile is hidden.
*/
hidden: number,
/**
* User ID
*/
id: number,
/**
* User last name
*/
last_name: string,
/**
*
*/
can_access_closed: boolean,
/**
*
*/
is_closed: boolean,
/**
*
*/
connections: UsersUserConnections,
/**
* User's date of birth
*/
bdate: string,
/**
* Information whether user's birthdate are hidden
*/
bdate_visibility: number,
/**
*
*/
city: BaseCity,
/**
*
*/
country: BaseCountry,
/**
* User's hometown
*/
home_town: string,
/**
* User maiden name
*/
maiden_name: string,
/**
*
*/
name_request: AccountNameRequest,
/**
*
*/
personal: UsersPersonal,
/**
* User phone number with some hidden digits
*/
phone: string,
/**
* User relationship status
*/
relation: UsersUserRelation,
/**
*
*/
relation_partner: UsersUserMin,
/**
* Information whether relation status is pending
*/
relation_pending: BaseBoolInt,
/**
*
*/
relation_requests: UsersUserMin[],
/**
* Domain name of the user's page
*/
screen_name: string,
/**
* User sex
*/
sex: BaseSex,
/**
* User status
*/
status: string,
/**
*
*/
status_audio: AudioAudio,
/**
*
*/
interests: AccountUserSettingsInterests,
/**
*
*/
languages: string[],
/**
* URL of square photo of the user with 200 pixels in width
*/
photo_200: string,
/**
* flag about service account
*/
is_service_account: boolean
}
export interface AccountUserSettingsInterest {
/**
*
*/
title: string,
/**
*
*/
value: string
}
export interface AccountUserSettingsInterests {
/**
*
*/
activities: AccountUserSettingsInterest,
/**
*
*/
interests: AccountUserSettingsInterest,
/**
*
*/
music: AccountUserSettingsInterest,
/**
*
*/
tv: AccountUserSettingsInterest,
/**
*
*/
movies: AccountUserSettingsInterest,
/**
*
*/
books: AccountUserSettingsInterest,
/**
*
*/
games: AccountUserSettingsInterest,
/**
*
*/
quotes: AccountUserSettingsInterest,
/**
*
*/
about: AccountUserSettingsInterest
}
export type AddressesFields = string
export type AdsAccessRole = string
export type AdsAccessRolePublic = string
export interface AdsAccesses {
/**
* Client ID
*/
client_id: string,
/**
*
*/
role: AdsAccessRole
}
export interface AdsAccount {
/**
*
*/
access_role: AdsAccessRole,
/**
* Account ID
*/
account_id: number,
/**
* Information whether account is active
*/
account_status: BaseBoolInt,
/**
*
*/
account_type: AdsAccountType,
/**
* Account name
*/
account_name: string,
/**
* Can user view account budget
*/
can_view_budget: boolean
}
export type AdsAccountType = string
export interface AdsAd {
/**
* Ad format
*/
ad_format: number,
/**
* Ad platform
*/
ad_platform: any,
/**
* Total limit
*/
all_limit: number,
/**
*
*/
approved: AdsAdApproved,
/**
* Campaign ID
*/
campaign_id: number,
/**
* Category ID
*/
category1_id: number,
/**
* Additional category ID
*/
category2_id: number,
/**
*
*/
cost_type: AdsAdCostType,
/**
* Cost of a click, kopecks
*/
cpc: number,
/**
* Cost of 1000 impressions, kopecks
*/
cpm: number,
/**
* Cost of an action, kopecks
*/
cpa: number,
/**
* Cost of 1000 impressions optimized, kopecks
*/
ocpm: number,
/**
* Max cost of target actions for autobidding, kopecks
*/
autobidding_max_cost: number,
/**
* Information whether disclaimer is enabled
*/
disclaimer_medical: BaseBoolInt,
/**
* Information whether disclaimer is enabled
*/
disclaimer_specialist: BaseBoolInt,
/**
* Information whether disclaimer is enabled
*/
disclaimer_supplements: BaseBoolInt,
/**
* Ad ID
*/
id: number,
/**
* Impressions limit
*/
impressions_limit: number,
/**
* Information whether impressions are limited
*/
impressions_limited: BaseBoolInt,
/**
* Ad title
*/
name: string,
/**
*
*/
status: AdsAdStatus,
/**
* Information whether the ad is a video
*/
video: BaseBoolInt
}
export type AdsAdApproved = number
export type AdsAdCostType = number
export interface AdsAdLayout {
/**
* Ad format
*/
ad_format: number,
/**
* Campaign ID
*/
campaign_id: number,
/**
*
*/
cost_type: AdsAdCostType,
/**
* Ad description
*/
description: string,
/**
* Ad ID
*/
id: number,
/**
* Image URL
*/
image_src: string,
/**
* URL of the preview image in double size
*/
image_src_2x: string,
/**
* Domain of advertised object
*/
link_domain: string,
/**
* URL of advertised object
*/
link_url: string,
/**
* link to preview an ad as it is shown on the website
*/
preview_link: any,
/**
* Ad title
*/
title: string,
/**
* Information whether the ad is a video
*/
video: BaseBoolInt
}
export type AdsAdStatus = number
export interface AdsCampaign {
/**
* Campaign's total limit, rubles
*/
all_limit: string,
/**
* Campaign's day limit, rubles
*/
day_limit: string,
/**
* Campaign ID
*/
id: number,
/**
* Campaign title
*/
name: string,
/**
* Campaign start time, as Unixtime
*/
start_time: number,
/**
*
*/
status: AdsCampaignStatus,
/**
* Campaign stop time, as Unixtime
*/
stop_time: number,
/**
*
*/
type: AdsCampaignType
}
export type AdsCampaignStatus = number
export type AdsCampaignType = string
export interface AdsCategory {
/**
* Category ID
*/
id: number,
/**
* Category name
*/
name: string,
/**
*
*/
subcategories: BaseObjectWithName[]
}
export interface AdsClient {
/**
* Client's total limit, rubles
*/
all_limit: string,
/**
* Client's day limit, rubles
*/
day_limit: string,
/**
* Client ID
*/
id: number,
/**
* Client name
*/
name: string
}
export interface AdsCriteria {
/**
* Age from
*/
age_from: number,
/**
* Age to
*/
age_to: number,
/**
* Apps IDs
*/
apps: string,
/**
* Apps IDs to except
*/
apps_not: string,
/**
* Days to birthday
*/
birthday: number,
/**
* Cities IDs
*/
cities: string,
/**
* Cities IDs to except
*/
cities_not: string,
/**
* Country ID
*/
country: number,
/**
* Districts IDs
*/
districts: string,
/**
* Communities IDs
*/
groups: string,
/**
* Interests categories IDs
*/
interest_categories: string,
/**
* Interests
*/
interests: string,
/**
* Information whether the user has proceeded VK payments before
*/
paying: BaseBoolInt,
/**
* Positions IDs
*/
positions: string,
/**
* Religions IDs
*/
religions: string,
/**
* Retargeting groups IDs
*/
retargeting_groups: string,
/**
* Retargeting groups IDs to except
*/
retargeting_groups_not: string,
/**
* School graduation year from
*/
school_from: number,
/**
* School graduation year to
*/
school_to: number,
/**
* Schools IDs
*/
schools: string,
/**
*
*/
sex: AdsCriteriaSex,
/**
* Stations IDs
*/
stations: string,
/**
* Relationship statuses
*/
statuses: string,
/**
* Streets IDs
*/
streets: string,
/**
* Travellers only
*/
travellers: BasePropertyExists,
/**
* University graduation year from
*/
uni_from: number,
/**
* University graduation year to
*/
uni_to: number,
/**
* Browsers
*/
user_browsers: string,
/**
* Devices
*/
user_devices: string,
/**
* Operating systems
*/
user_os: string
}
export type AdsCriteriaSex = number
export interface AdsDemoStats {
/**
* Object ID
*/
id: number,
/**
*
*/
stats: AdsDemostatsFormat,
/**
*
*/
type: AdsObjectType
}
export interface AdsDemostatsFormat {
/**
*
*/
age: AdsStatsAge[],
/**
*
*/
cities: AdsStatsCities[],
/**
* Day as YYYY-MM-DD
*/
day: string,
/**
* Month as YYYY-MM
*/
month: string,
/**
* 1 if period=overall
*/
overall: number,
/**
*
*/
sex: AdsStatsSex[],
/**
*
*/
sex_age: AdsStatsSexAge[]
}
export interface AdsFloodStats {
/**
* Requests left
*/
left: number,
/**
* Time to refresh in seconds
*/
refresh: number
}
export interface AdsLinkStatus {
/**
* Reject reason
*/
description: string,
/**
* URL
*/
redirect_url: string,
/**
* Link status
*/
status: string
}
export interface AdsLookalikeRequest {
/**
* Lookalike request ID
*/
id: number,
/**
* Lookalike request create time, as Unixtime
*/
create_time: number,
/**
* Lookalike request update time, as Unixtime
*/
update_time: number,
/**
* Time by which lookalike request would be deleted, as Unixtime
*/
scheduled_delete_time: number,
/**
* Lookalike request status
*/
status: string,
/**
* Lookalike request source type
*/
source_type: string,
/**
* Retargeting group id, which was used as lookalike seed
*/
source_retargeting_group_id: number,
/**
* Lookalike request seed name (retargeting group name)
*/
source_name: string,
/**
* Lookalike request seed audience size
*/
audience_count: number,
/**
*
*/
save_audience_levels: AdsLookalikeRequestSaveAudienceLevel[]
}
export interface AdsLookalikeRequestSaveAudienceLevel {
/**
* Save audience level id, which is used in save audience queries
*/
level: number,
/**
* Saved audience audience size for according level
*/
audience_count: number
}
export interface AdsMusician {
/**
* Targeting music artist ID
*/
id: number,
/**
* Music artist name
*/
name: string
}
export type AdsObjectType = string
export interface AdsParagraphs {
/**
* Rules paragraph
*/
paragraph: string
}
export interface AdsPromotedPostReach {
/**
* Hides amount
*/
hide: number,
/**
* Object ID from 'ids' parameter
*/
id: number,
/**
* Community joins
*/
join_group: number,
/**
* Link clicks
*/
links: number,
/**
* Subscribers reach
*/
reach_subscribers: number,
/**
* Total reach
*/
reach_total: number,
/**
* Reports amount
*/
report: number,
/**
* Community clicks
*/
to_group: number,
/**
* 'Unsubscribe' events amount
*/
unsubscribe: number,
/**
* Video views for 100 percent
*/
video_views_100p: number,
/**
* Video views for 25 percent
*/
video_views_25p: number,
/**
* Video views for 3 seconds
*/
video_views_3s: number,
/**
* Video views for 50 percent
*/
video_views_50p: number,
/**
* Video views for 75 percent
*/
video_views_75p: number,
/**
* Video starts
*/
video_views_start: number
}
export interface AdsRejectReason {
/**
* Comment text
*/
comment: string,
/**
*
*/
rules: AdsRules[]
}
export interface AdsRules {
/**
*
*/
paragraphs: AdsParagraphs[],
/**
* Comment
*/
title: string
}
export interface AdsStats {
/**
* Object ID
*/
id: number,
/**
*
*/
stats: AdsStatsFormat,
/**
*
*/
type: AdsObjectType,
/**
*
*/
views_times: AdsStatsViewsTimes
}
export interface AdsStatsAge {
/**
* Clicks rate
*/
clicks_rate: number,
/**
* Impressions rate
*/
impressions_rate: number,
/**
* Age interval
*/
value: string
}
export interface AdsStatsCities {
/**
* Clicks rate
*/
clicks_rate: number,
/**
* Impressions rate
*/
impressions_rate: number,
/**
* City name
*/
name: string,
/**
* City ID
*/
value: number
}
export interface AdsStatsFormat {
/**
* Clicks number
*/
clicks: number,
/**
* Day as YYYY-MM-DD
*/
day: string,
/**
* Impressions number
*/
impressions: number,
/**
* Events number
*/
join_rate: number,
/**
* Month as YYYY-MM
*/
month: string,
/**
* 1 if period=overall
*/
overall: number,
/**
* Reach
*/
reach: number,
/**
* Spent funds
*/
spent: number,
/**
* Clickthoughs to the advertised site
*/
video_clicks_site: number,
/**
* Video views number
*/
video_views: number,
/**
* Video views (full video)
*/
video_views_full: number,
/**
* Video views (half of video)
*/
video_views_half: number
}
export interface AdsStatsSex {
/**
* Clicks rate
*/
clicks_rate: number,
/**
* Impressions rate
*/
impressions_rate: number,
/**
*
*/
value: AdsStatsSexValue
}
export interface AdsStatsSexAge {
/**
* Clicks rate
*/
clicks_rate: number,
/**
* Impressions rate
*/
impressions_rate: number,
/**
* Sex and age interval
*/
value: string
}
export type AdsStatsSexValue = string
export interface AdsStatsViewsTimes {
/**
*
*/
views_ads_times_1: number,
/**
*
*/
views_ads_times_2: number,
/**
*
*/
views_ads_times_3: number,
/**
*
*/
views_ads_times_4: number,
/**
*
*/
views_ads_times_5: string,
/**
*
*/
views_ads_times_6: number,
/**
*
*/
views_ads_times_7: number,
/**
*
*/
views_ads_times_8: number,
/**
*
*/
views_ads_times_9: number,
/**
*
*/
views_ads_times_10: number,
/**
*
*/
views_ads_times_11_plus: number
}
export interface AdsTargSettings {
/**
* Ad ID
*/
id: number,
/**
* Campaign ID
*/
campaign_id: number,
/**
* Age from
*/
age_from: number,
/**
* Age to
*/
age_to: number,
/**
* Apps IDs
*/
apps: string,
/**
* Apps IDs to except
*/
apps_not: string,
/**
* Days to birthday
*/
birthday: number,
/**
* Cities IDs
*/
cities: string,
/**
* Cities IDs to except
*/
cities_not: string,
/**
* Country ID
*/
country: number,
/**
* Districts IDs
*/
districts: string,
/**
* Communities IDs
*/
groups: string,
/**
* Interests categories IDs
*/
interest_categories: string,
/**
* Interests
*/
interests: string,
/**
* Information whether the user has proceeded VK payments before
*/
paying: BaseBoolInt,
/**
* Positions IDs
*/
positions: string,
/**
* Religions IDs
*/
religions: string,
/**
* Retargeting groups IDs
*/
retargeting_groups: string,
/**
* Retargeting groups IDs to except
*/
retargeting_groups_not: string,
/**
* School graduation year from
*/
school_from: number,
/**
* School graduation year to
*/
school_to: number,
/**
* Schools IDs
*/
schools: string,
/**
*
*/
sex: AdsCriteriaSex,
/**
* Stations IDs
*/
stations: string,
/**
* Relationship statuses
*/
statuses: string,
/**
* Streets IDs
*/
streets: string,
/**
* Travellers only
*/
travellers: BasePropertyExists,
/**
* University graduation year from
*/
uni_from: number,
/**
* University graduation year to
*/
uni_to: number,
/**
* Browsers
*/
user_browsers: string,
/**
* Devices
*/
user_devices: string,
/**
* Operating systems
*/
user_os: string
}
export interface AdsTargStats {
/**
* Audience
*/
audience_count: number,
/**
* Recommended CPC value for 50% reach (old format)
*/
recommended_cpc: number,
/**
* Recommended CPM value for 50% reach (old format)
*/
recommended_cpm: number,
/**
* Recommended CPC value for 50% reach
*/
recommended_cpc_50: number,
/**
* Recommended CPM value for 50% reach
*/
recommended_cpm_50: number,
/**
* Recommended CPC value for 70% reach
*/
recommended_cpc_70: number,
/**
* Recommended CPM value for 70% reach
*/
recommended_cpm_70: number,
/**
* Recommended CPC value for 90% reach
*/
recommended_cpc_90: number,
/**
* Recommended CPM value for 90% reach
*/
recommended_cpm_90: number
}
export interface AdsTargSuggestions {
/**
* Object ID
*/
id: number,
/**
* Object name
*/
name: string
}
export interface AdsTargSuggestionsCities {
/**
* Object ID
*/
id: number,
/**
* Object name
*/
name: string,
/**
* Parent object
*/
parent: string
}
export interface AdsTargSuggestionsRegions {
/**
* Object ID
*/
id: number,
/**
* Object name
*/
name: string,
/**
* Object type
*/
type: string
}
export interface AdsTargSuggestionsSchools {
/**
* Full school title
*/
desc: string,
/**
* School ID
*/
id: number,
/**
* School title
*/
name: string,
/**
* City name
*/
parent: string,
/**
*
*/
type: AdsTargSuggestionsSchoolsType
}
export type AdsTargSuggestionsSchoolsType = string
export interface AdsTargetGroup {
/**
* Audience
*/
audience_count: number,
/**
* Site domain
*/
domain: string,
/**
* Group ID
*/
id: number,
/**
* Number of days for user to be in group
*/
lifetime: number,
/**
* Group name
*/
name: string,
/**
* Pixel code
*/
pixel: string
}
export interface AdsUpdateOfficeUsersResult {
/**
*
*/
user_id: number,
/**
*
*/
is_success: boolean,
/**
*
*/
error: BaseError
}
export interface AdsUserSpecification {
/**
*
*/
user_id: number,
/**
*
*/
role: AdsAccessRolePublic,
/**
*
*/
grant_access_to_all_clients: boolean,
/**
*
*/
client_ids: number[],
/**
*
*/
view_budget: boolean
}
export interface AdsUserSpecificationCutted {
/**
*
*/
user_id: number,
/**
*
*/
role: AdsAccessRolePublic,
/**
*
*/
client_id: number,
/**
*
*/
view_budget: boolean
}
export interface AdsUsers {
/**
*
*/
accesses: AdsAccesses[],
/**
* User ID
*/
user_id: number
}
export interface AdswebGetAdCategoriesResponseCategoriesCategory {
/**
*
*/
id: number,
/**
*
*/
name: string
}
export interface AdswebGetAdUnitsResponseAdUnitsAdUnit {
/**
*
*/
id: number,
/**
*
*/
site_id: number,
/**
*
*/
name: string
}
export interface AdswebGetFraudHistoryResponseEntriesEntry {
/**
*
*/
site_id: number,
/**
*
*/
day: string
}
export interface AdswebGetSitesResponseSitesSite {
/**
*
*/
id: number,
/**
*
*/
status_user: string,
/**
*
*/
status_moder: string,
/**
*
*/
domains: string
}
export interface AdswebGetStatisticsResponseItemsItem {
/**
*
*/
site_id: number,
/**
*
*/
ad_unit_id: number,
/**
*
*/
overall_count: number,
/**
*
*/
months_count: number,
/**
*
*/
month_min: string,
/**
*
*/
month_max: string,
/**
*
*/
days_count: number,
/**
*
*/
day_min: string,
/**
*
*/
day_max: string,
/**
*
*/
hours_count: number,
/**
*
*/
hour_min: string,
/**
*
*/
hour_max: string
}
export interface AppWidgetsPhoto {
/**
* Image ID
*/
id: string,
/**
*
*/
images: BaseImage[]
}
export interface AppWidgetsPhotos {
/**
*
*/
count: number,
/**
*
*/
items: AppWidgetsPhoto[]
}
export interface AppsApp {
/**
*
*/
type: AppsAppType,
/**
* Application ID
*/
id: number,
/**
* Application title
*/
title: string,
/**
* Application author's ID
*/
author_owner_id: number,
/**
* Is application installed
*/
is_installed: boolean,
/**
* URL of the app icon with 139 px in width
*/
icon_139: string,
/**
* URL of the app icon with 150 px in width
*/
icon_150: string,
/**
* URL of the app icon with 278 px in width
*/
icon_278: string,
/**
* URL of the app icon with 576 px in width
*/
icon_576: string,
/**
* Hex color code without hash sign
*/
background_loader_color: string,
/**
* SVG data
*/
loader_icon: string,
/**
* URL of the app icon with 75 px in width
*/
icon_75: string,
/**
* Application author's URL
*/
author_url: string,
/**
* URL of the app banner with 1120 px in width
*/
banner_1120: string,
/**
* URL of the app banner with 560 px in width
*/
banner_560: string,
/**
* URL of the app icon with 16 px in width
*/
icon_16: string,
/**
* Is new flag
*/
is_new: BaseBoolInt,
/**
* Is push enabled
*/
push_enabled: BaseBoolInt,
/**
* Screen orientation
*/
screen_orientation: number,
/**
*
*/
friends: number[],
/**
* Catalog position
*/
catalog_position: number,
/**
* Application description
*/
description: string,
/**
* Genre name
*/
genre: string,
/**
* Genre ID
*/
genre_id: number,
/**
* Information whether the application is multilanguage
*/
international: boolean,
/**
* Information whether application is in mobile catalog
*/
is_in_catalog: number,
/**
*
*/
leaderboard_type: AppsAppLeaderboardType,
/**
* Members number
*/
members_count: number,
/**
* Application ID in store
*/
platform_id: string,
/**
* Date when the application has been published in Unixtime
*/
published_date: number,
/**
* Screen name
*/
screen_name: string,
/**
* Application section name
*/
section: string
}
export type AppsAppLeaderboardType = number
export interface AppsAppMin {
/**
*
*/
type: AppsAppType,
/**
* Application ID
*/
id: number,
/**
* Application title
*/
title: string,
/**
* Application author's ID
*/
author_owner_id: number,
/**
* Is application installed
*/
is_installed: boolean,
/**
* URL of the app icon with 139 px in width
*/
icon_139: string,
/**
* URL of the app icon with 150 px in width
*/
icon_150: string,
/**
* URL of the app icon with 278 px in width
*/
icon_278: string,
/**
* URL of the app icon with 576 px in width
*/
icon_576: string,
/**
* Hex color code without hash sign
*/
background_loader_color: string,
/**
* SVG data
*/
loader_icon: string,
/**
* URL of the app icon with 75 px in width
*/
icon_75: string
}
export type AppsAppType = string
export interface AppsLeaderboard {
/**
* Level
*/
level: number,
/**
* Points number
*/
points: number,
/**
* Score number
*/
score: number,
/**
* User ID
*/
user_id: number
}
export interface AppsScope {
/**
* Scope name
*/
name: string,
/**
* Scope title
*/
title: string
}
export interface AudioAudio {
/**
* Artist name
*/
artist: string,
/**
* Audio ID
*/
id: number,
/**
* Title
*/
title: string,
/**
* URL of mp3 file
*/
url: string,
/**
* Duration in seconds
*/
duration: number,
/**
* Date when uploaded
*/
date: number,
/**
* Album ID
*/
album_id: number,
/**
* Genre ID
*/
genre_id: number,
/**
* Performer name
*/
performer: string
}
export type BaseBoolInt = number
export interface BaseCity {
/**
* City ID
*/
id: number,
/**
* City title
*/
title: string
}
export interface BaseCommentsInfo {
/**
* Information whether current user can comment the post
*/
can_post: BaseBoolInt,
/**
* Comments number
*/
count: number,
/**
* Information whether groups can comment the post
*/
groups_can_post: boolean,
/**
*
*/
donut: WallWallpostCommentsDonut
}
export interface BaseCountry {
/**
* Country ID
*/
id: number,
/**
* Country title
*/
title: string
}
export interface BaseCropPhoto {
/**
*
*/
photo: PhotosPhoto,
/**
*
*/
crop: BaseCropPhotoCrop,
/**
*
*/
rect: BaseCropPhotoRect
}
export interface BaseCropPhotoCrop {
/**
* Coordinate X of the left upper corner
*/
x: number,
/**
* Coordinate Y of the left upper corner
*/
y: number,
/**
* Coordinate X of the right lower corner
*/
x2: number,
/**
* Coordinate Y of the right lower corner
*/
y2: number
}
export interface BaseCropPhotoRect {
/**
* Coordinate X of the left upper corner
*/
x: number,
/**
* Coordinate Y of the left upper corner
*/
y: number,
/**
* Coordinate X of the right lower corner
*/
x2: number,
/**
* Coordinate Y of the right lower corner
*/
y2: number
}
export interface BaseError {
/**
* Error code
*/
error_code: number,
/**
* Error subcode
*/
error_subcode: number,
/**
* Error message
*/
error_msg: string,
/**
* Localized error message
*/
error_text: string,
/**
*
*/
request_params: BaseRequestParam[]
}
export interface BaseGeo {
/**
*
*/
coordinates: BaseGeoCoordinates,
/**
*
*/
place: BasePlace,
/**
* Information whether a map is showed
*/
showmap: number,
/**
* Place type
*/
type: string
}
export interface BaseGeoCoordinates {
/**
*
*/
latitude: number,
/**
*
*/
longitude: number
}
export interface BaseGradientPoint {
/**
* Hex color code without #
*/
color: string,
/**
* Point position
*/
position: number
}
export interface BaseImage {
/**
*
*/
id: string,
/**
* Image height
*/
height: number,
/**
* Image url
*/
url: string,
/**
* Image width
*/
width: number
}
export interface BaseLikes {
/**
* Likes number
*/
count: number,
/**
* Information whether current user likes the photo
*/
user_likes: BaseBoolInt
}
export interface BaseLikesInfo {
/**
* Information whether current user can like the post
*/
can_like: BaseBoolInt,
/**
* Information whether current user can repost
*/
can_publish: BaseBoolInt,
/**
* Likes number
*/
count: number,
/**
* Information whether current uer has liked the post
*/
user_likes: number
}
export interface BaseLink {
/**
*
*/
application: BaseLinkApplication,
/**
*
*/
button: BaseLinkButton,
/**
* Link caption
*/
caption: string,
/**
* Link description
*/
description: string,
/**
* Link ID
*/
id: string,
/**
*
*/
is_favorite: boolean,
/**
*
*/
photo: PhotosPhoto,
/**
* String ID of the page with article preview
*/
preview_page: string,
/**
* URL of the page with article preview
*/
preview_url: string,
/**
*
*/
product: BaseLinkProduct,
/**
*
*/
rating: BaseLinkRating,
/**
* Link title
*/
title: string,
/**
* Link URL
*/
url: string,
/**
*
*/
target_object: LinkTargetObject,
/**
* Information whether the current link is external
*/
is_external: boolean,
/**
* Video from link
*/
video: VideoVideo
}
export interface BaseLinkApplication {
/**
* Application Id
*/
app_id: number,
/**
*
*/
store: BaseLinkApplicationStore
}
export interface BaseLinkApplicationStore {
/**
* Store Id
*/
id: number,
/**
* Store name
*/
name: string
}
export interface BaseLinkButton {
/**
* Button action
*/
action: BaseLinkButtonAction,
/**
* Button title
*/
title: string,
/**
* Target block id
*/
block_id: string,
/**
* Target section id
*/
section_id: string,
/**
* curator id
*/
curator_id: number,
/**
* Owner id
*/
owner_id: number,
/**
* Button icon name, e.g. 'phone' or 'gift'
*/
icon: string,
/**
*
*/
style: BaseLinkButtonStyle
}
export interface BaseLinkButtonAction {
/**
*
*/
type: BaseLinkButtonActionType,
/**
* Action URL
*/
url: string,
/**
*
*/
consume_reason: string
}
export type BaseLinkButtonActionType = string
export type BaseLinkButtonStyle = string
export interface BaseLinkProduct {
/**
*
*/
price: MarketPrice,
/**
*
*/
merchant: string,
/**
*
*/
orders_count: number
}
export type BaseLinkProductStatus = string
export interface BaseLinkRating {
/**
* Count of reviews
*/
reviews_count: number,
/**
* Count of stars
*/
stars: number
}
export interface BaseMessageError {
/**
* Error code
*/
code: number,
/**
* Error message
*/
description: string
}
export interface BaseObject {
/**
* Object ID
*/
id: number,
/**
* Object title
*/
title: string
}
export interface BaseObjectCount {
/**
* Items count
*/
count: number
}
export interface BaseObjectWithName {
/**
* Object ID
*/
id: number,
/**
* Object name
*/
name: string
}
export interface BasePlace {
/**
* Place address
*/
address: string,
/**
* Checkins number
*/
checkins: number,
/**
* City name
*/
city: string,
/**
* Country name
*/
country: string,
/**
* Date of the place creation in Unixtime
*/
created: number,
/**
* URL of the place's icon
*/
icon: string,
/**
* Place ID
*/
id: number,
/**
* Place latitude
*/
latitude: number,
/**
* Place longitude
*/
longitude: number,
/**
* Place title
*/
title: string,
/**
* Place type
*/
type: string
}
export type BasePropertyExists = number
export interface BaseRepostsInfo {
/**
* Total reposts counter. Sum of wall and mail reposts counters
*/
count: number,
/**
* Wall reposts counter
*/
wall_count: number,
/**
* Mail reposts counter
*/
mail_count: number,
/**
* Information whether current user has reposted the post
*/
user_reposted: number
}
export interface BaseRequestParam {
/**
* Parameter name
*/
key: string,
/**
* Parameter value
*/
value: string
}
export type BaseSex = number
export interface BaseSticker {
/**
* Sticker ID
*/
sticker_id: number,
/**
* Pack ID
*/
product_id: number,
/**
*
*/
images: BaseImage[],
/**
*
*/
images_with_background: BaseImage[],
/**
* URL of sticker animation script
*/
animation_url: string,
/**
* Array of sticker animation script objects
*/
animations: BaseStickerAnimation[],
/**
* Information whether the sticker is allowed
*/
is_allowed: boolean
}
export interface BaseStickerAnimation {
/**
* Type of animation script
*/
type: string,
/**
* URL of animation script
*/
url: string
}
export interface BaseUploadServer {
/**
* Upload URL
*/
upload_url: string
}
export type BaseUserGroupFields = string
export interface BaseUserId {
/**
* User ID
*/
user_id: number
}
export type BoardDefaultOrder = number
export interface BoardTopic {
/**
* Comments number
*/
comments: number,
/**
* Date when the topic has been created in Unixtime
*/
created: number,
/**
* Creator ID
*/
created_by: number,
/**
* Topic ID
*/
id: number,
/**
* Information whether the topic is closed
*/
is_closed: BaseBoolInt,
/**
* Information whether the topic is fixed
*/
is_fixed: BaseBoolInt,
/**
* Topic title
*/
title: string,
/**
* Date when the topic has been updated in Unixtime
*/
updated: number,
/**
* ID of user who updated the topic
*/
updated_by: number
}
export interface BoardTopicComment {
/**
*
*/
attachments: WallCommentAttachment[],
/**
* Date when the comment has been added in Unixtime
*/
date: number,
/**
* Author ID
*/
from_id: number,
/**
* Comment ID
*/
id: number,
/**
* Real position of the comment
*/
real_offset: number,
/**
* Comment text
*/
text: string,
/**
* Information whether current user can edit the comment
*/
can_edit: BaseBoolInt,
/**
*
*/
likes: BaseLikesInfo
}
export interface BoardTopicPoll {
/**
* Poll owner's ID
*/
owner_id: number,
/**
* Poll ID
*/
poll_id: number,
/**
* Date when poll has been created in Unixtime
*/
created: number,
/**
* Information whether the poll is closed
*/
is_closed: BaseBoolInt,
/**
* Poll question
*/
question: string,
/**
* Votes number
*/
votes: number,
/**
* Current user's answer ID
*/
answer_id: number,
/**
*
*/
answers: PollsAnswer[]
}
export interface CallbackBoardPostDelete {
/**
*
*/
topic_owner_id: number,
/**
*
*/
topic_id: number,
/**
*
*/
id: number
}
export interface CallbackConfirmationMessage {
/**
*
*/
type: CallbackMessageType,
/**
*
*/
group_id: number,
/**
*
*/
secret: string
}
export interface CallbackDonutMoneyWithdraw {
/**
*
*/
amount: number,
/**
*
*/
amount_without_fee: number
}
export interface CallbackDonutMoneyWithdrawError {
/**
*
*/
reason: string
}
export interface CallbackDonutSubscriptionCancelled {
/**
*
*/
user_id: number
}
export interface CallbackDonutSubscriptionCreate {
/**
*
*/
user_id: number,
/**
*
*/
amount: number,
/**
*
*/
amount_without_fee: number
}
export interface CallbackDonutSubscriptionExpired {
/**
*
*/
user_id: number
}
export interface CallbackDonutSubscriptionPriceChanged {
/**
*
*/
user_id: number,
/**
*
*/
amount_old: number,
/**
*
*/
amount_new: number,
/**
*
*/
amount_diff: number,
/**
*
*/
amount_diff_without_fee: number
}
export interface CallbackDonutSubscriptionProlonged {
/**
*
*/
user_id: number,
/**
*
*/
amount: number,
/**
*
*/
amount_without_fee: number
}
export interface CallbackGroupChangePhoto {
/**
*
*/
user_id: number,
/**
*
*/
photo: PhotosPhoto
}
export interface CallbackGroupChangeSettings {
/**
*
*/
user_id: number,
/**
*
*/
self: BaseBoolInt
}
export interface CallbackGroupJoin {
/**
*
*/
user_id: number,
/**
*
*/
join_type: CallbackGroupJoinType
}
export type CallbackGroupJoinType = string
export interface CallbackGroupLeave {
/**
*
*/
user_id: number,
/**
*
*/
self: BaseBoolInt
}
export type CallbackGroupMarket = number
export type CallbackGroupOfficerRole = number
export interface CallbackGroupOfficersEdit {
/**
*
*/
admin_id: number,
/**
*
*/
user_id: number,
/**
*
*/
level_old: CallbackGroupOfficerRole,
/**
*
*/
level_new: CallbackGroupOfficerRole
}
export interface CallbackGroupSettingsChanges {
/**
*
*/
title: string,
/**
*
*/
description: string,
/**
*
*/
access: GroupsGroupIsClosed,
/**
*
*/
screen_name: string,
/**
*
*/
public_category: number,
/**
*
*/
public_subcategory: number,
/**
*
*/
age_limits: GroupsGroupFullAgeLimits,
/**
*
*/
website: string,
/**
*
*/
enable_status_default: GroupsGroupWall,
/**
*
*/
enable_audio: GroupsGroupAudio,
/**
*
*/
enable_video: GroupsGroupVideo,
/**
*
*/
enable_photo: GroupsGroupPhotos,
/**
*
*/
enable_market: CallbackGroupMarket
}
export interface CallbackLikeAddRemove {
/**
*
*/
liker_id: number,
/**
*
*/
object_type: string,
/**
*
*/
object_owner_id: number,
/**
*
*/
object_id: number,
/**
*
*/
post_id: number,
/**
*
*/
thread_reply_id: number
}
export interface CallbackMarketComment {
/**
*
*/
id: number,
/**
*
*/
from_id: number,
/**
*
*/
date: number,
/**
*
*/
text: string,
/**
*
*/
market_owner_od: number,
/**
*
*/
photo_id: number
}
export interface CallbackMarketCommentDelete {
/**
*
*/
owner_id: number,
/**
*
*/
id: number,
/**
*
*/
user_id: number,
/**
*
*/
item_id: number
}
export interface CallbackMessageAllow {
/**
*
*/
user_id: number,
/**
*
*/
key: string
}
export type CallbackMessageBase = any
export interface CallbackMessageDeny {
/**
*
*/
user_id: number
}
export type CallbackMessageType = string
export interface CallbackPhotoComment {
/**
*
*/
id: number,
/**
*
*/
from_id: number,
/**
*
*/
date: number,
/**
*
*/
text: string,
/**
*
*/
photo_owner_od: number
}
export interface CallbackPhotoCommentDelete {
/**
*
*/
id: number,
/**
*
*/
owner_id: number,
/**
*
*/
user_id: number,
/**
*
*/
photo_id: number
}
export interface CallbackPollVoteNew {
/**
*
*/
owner_id: number,
/**
*
*/
poll_id: number,
/**
*
*/
option_id: number,
/**
*
*/
user_id: number
}
export interface CallbackQrScan {
/**
*
*/
user_id: number,
/**
*
*/
data: string,
/**
*
*/
type: string,
/**
*
*/
subtype: string,
/**
*
*/
reread: boolean
}
export interface CallbackUserBlock {
/**
*
*/
admin_id: number,
/**
*
*/
user_id: number,
/**
*
*/
unblock_date: number,
/**
*
*/
reason: number,
/**
*
*/
comment: string
}
export interface CallbackUserUnblock {
/**
*
*/
admin_id: number,
/**
*
*/
user_id: number,
/**
*
*/
by_end_date: number
}
export interface CallbackVideoComment {
/**
*
*/
id: number,
/**
*
*/
from_id: number,
/**
*
*/
date: number,
/**
*
*/
text: string,
/**
*
*/
video_owner_od: number
}
export interface CallbackVideoCommentDelete {
/**
*
*/
id: number,
/**
*
*/
owner_id: number,
/**
*
*/
user_id: number,
/**
*
*/
video_id: number
}
export interface CallbackWallCommentDelete {
/**
*
*/
owner_id: number,
/**
*
*/
id: number,
/**
*
*/
user_id: number,
/**
*
*/
post_id: number
}
export interface CallsCall {
/**
* Call duration
*/
duration: number,
/**
* Caller initiator
*/
initiator_id: number,
/**
* Caller receiver
*/
receiver_id: number,
/**
*
*/
state: CallsEndState,
/**
* Timestamp for call
*/
time: number,
/**
* Was this call initiated as video call
*/
video: boolean
}
export type CallsEndState = string
export interface Calls