vk-io
Version:
Modern VK API SDK for Node.js
2,578 lines • 202 kB
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 recommendations number
*/
friends_recommendations: number;
/**
* New gifts number
*/
gifts: number;
/**
* New groups number
*/
groups: 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;
[key: string]: any;
}
export type AccountCountersFilter = "app_requests" | "events" | "friends" | "friends_recommendations" | "gifts" | "groups" | "messages" | "notes" | "notifications" | "photos" | "faves" | "memories";
export interface AccountInfo {
/**
* Country code
*/
country: string;
/**
* Language ID
*/
lang: number;
[key: string]: any;
}
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;
/**
* 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;
[key: string]: any;
}
export type AccountNameRequestStatus = "success" | "processing" | "declined" | "was_accepted" | "was_declined" | "declined_with_link" | "response" | "response_with_link";
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: "profile" | "group" | "app";
[key: string]: any;
}
export interface AccountPushConversations {
/**
* Items count
*/
count: number;
[key: string]: any;
items: AccountPushConversationsItem[];
}
export interface AccountPushConversationsItem {
/**
* Time until that notifications are disabled in seconds
*/
disabled_until: number;
/**
* Peer ID
*/
peer_id: number;
[key: string]: any;
}
export interface AccountPushParams {
[key: string]: any;
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 = "on" | "off" | "no_sound" | "no_text";
export type AccountPushParamsOnoff = "on" | "off";
export type AccountPushParamsSettings = "on" | "off" | "fr_of_fr";
export interface AccountPushSettings {
/**
* Time until that notifications are disabled in Unixtime
*/
disabled_until: number;
[key: string]: any;
}
export interface AccountUserSettings1 {
/**
* URL of square photo of the user with 200 pixels in width
*/
photo_200: string;
/**
* flag about service account
*/
is_service_account: boolean | number;
}
export type AccountUserSettings = UsersUserMin & UsersUserSettingsXtr & AccountUserSettings1;
export interface AccountUserSettingsInterest {
[key: string]: any;
title: string;
value: string;
}
export interface AccountUserSettingsInterests {
[key: string]: any;
}
export type AddressesFields = "id" | "title" | "address" | "additional_address" | "country_id" | "city_id" | "metro_station_id" | "latitude" | "longitude" | "distance" | "work_info_status" | "timetable" | "phone" | "time_offset";
export type AddressFields = "id" | "title" | "address" | "additional_address" | "country_id" | "country" | "city_id" | "city" | "metro_station_id" | "metro_station" | "latitude" | "longitude" | "distance" | "work_info_status" | "timetable" | "phone" | "time_offset";
export type AdsAccessRole = "admin" | "manager" | "reports";
export type AdsAccessRolePublic = "manager" | "reports";
export interface AdsAccesses {
/**
* Client ID
*/
client_id: string;
[key: string]: any;
}
export interface AdsAccount {
/**
* Account ID
*/
account_id: number;
/**
* Account name
*/
account_name: string;
/**
* Can user view account budget
*/
can_view_budget: boolean | number;
[key: string]: any;
}
export type AdsAccountType = "general" | "agency";
export interface AdsAd {
/**
* Ad format
*/
ad_format: number;
/**
* Total limit
*/
all_limit: string;
/**
* Campaign ID
*/
campaign_id: number;
/**
* Category ID
*/
category1_id: number;
/**
* Additional category ID
*/
category2_id: number;
/**
* Cost of a click, kopecks
*/
cpc: string;
/**
* Cost of 1000 impressions, kopecks
*/
cpm: string;
/**
* Cost of an action, kopecks
*/
cpa: string;
/**
* Cost of 1000 impressions optimized, kopecks
*/
ocpm: string;
/**
* Max cost of target actions for autobidding, kopecks
*/
autobidding_max_cost: string;
/**
* Ad ID
*/
id: number;
/**
* Impressions limit
*/
impressions_limit: number;
/**
* Impressions limit period
*/
impressions_limit_period: number;
/**
* Ad title
*/
name: string;
/**
* Day limit
*/
day_limit: string;
/**
* Goal type
*/
goal_type: number;
/**
* User goal type
*/
user_goal_type: number;
/**
* Age restriction
*/
age_restriction: number;
/**
* Conversion pixel id
*/
conversion_pixel_id: number;
/**
* Conversion event id
*/
conversion_event_id: number;
/**
* Create time
*/
create_time: number;
/**
* Update time
*/
update_time: number;
/**
* Start time
*/
start_time: number;
/**
* Stop time
*/
stop_time: number;
/**
* Publisher platforms
*/
publisher_platforms: string;
/**
* Link url
*/
link_url: string;
/**
* Link owner id
*/
link_owner_id: number;
/**
* Link id
*/
link_id: number;
/**
* Has campaign budget optimization
*/
has_campaign_budget_optimization: boolean | number;
/**
* Weekly schedule use holidays
*/
weekly_schedule_use_holidays: number;
/**
* Ad platform no ad network
*/
ad_platform_no_ad_network: number;
/**
* Ad platform no wall
*/
ad_platform_no_wall: number;
/**
* Disclaimer finance
*/
disclaimer_finance: number;
/**
* Disclaimer finance name
*/
disclaimer_finance_name: string;
/**
* Disclaimer finance license no
*/
disclaimer_finance_license_no: string;
/**
* is promo
*/
is_promo: boolean | number;
/**
* Suggested criteria
*/
suggested_criteria: number;
[key: string]: any;
events_retargeting_groups: AdsEventsRetargetingGroup[];
weekly_schedule_hours: string[];
}
export type AdsAdApproved = 0 | 1 | 2 | 3;
export type AdsAdCostType = 0 | 1 | 2 | 3;
export interface AdsAdLayout {
/**
* Ad format
*/
ad_format: number;
/**
* Campaign ID
*/
campaign_id: number;
/**
* 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;
/**
* Type of advertised object
*/
link_type: number;
/**
* link to preview an ad as it is shown on the website
*/
preview_link: string;
/**
* Ad title
*/
title: string;
/**
* Social
*/
social: boolean | number;
/**
* Okved
*/
okved: string;
/**
* Age restriction
*/
age_restriction: number;
/**
* Goal type
*/
goal_type: number;
/**
* Link title
*/
link_title: string;
/**
* Link button
*/
link_button: string;
/**
* Repeat video
*/
repeat_video: number;
/**
* Video source 240p
*/
video_src_240: string;
/**
* Video source 360p
*/
video_src_360: string;
/**
* Video source 480p
*/
video_src_480: string;
/**
* Video source 720p
*/
video_src_720: string;
/**
* Video source 1080p
*/
video_src_1080: string;
/**
* Video image source
*/
video_image_src: string;
/**
* Video image source 2x
*/
video_image_src_2x: string;
/**
* Video duration
*/
video_duration: number;
/**
* Icon source
*/
icon_src: string;
/**
* Icon source 2x
*/
icon_src_2x: string;
[key: string]: any;
clips_list: AdsClipItem[];
}
export type AdsAdStatus = 0 | 1 | 2;
export interface AdsCampaign {
/**
* Amount of active ads in campaign
*/
ads_count: number;
/**
* Campaign's total limit, rubles
*/
all_limit: string;
/**
* Campaign create time, as Unixtime
*/
create_time: number;
/**
* Campaign goal type
*/
goal_type: number;
/**
* Campaign user goal type
*/
user_goal_type: number;
/**
* Shows if Campaign Budget Optimization is on
*/
is_cbo_enabled: boolean | number;
/**
* Campaign's day limit, rubles
*/
day_limit: string;
/**
* Campaign ID
*/
id: number;
/**
* Campaign title
*/
name: string;
/**
* Campaign start time, as Unixtime
*/
start_time: number;
/**
* Campaign stop time, as Unixtime
*/
stop_time: number;
/**
* Campaign update time, as Unixtime
*/
update_time: number;
/**
* Limit of views per user per campaign
*/
views_limit: number;
[key: string]: any;
}
export type AdsCampaignStatus = 0 | 1 | 2;
export type AdsCampaignType = "normal" | "vk_apps_managed" | "mobile_apps" | "promoted_posts" | "adaptive_ads" | "stories";
export interface AdsCategory {
/**
* Category ID
*/
id: number;
/**
* Category name
*/
name: string;
[key: string]: any;
subcategories: AdsCategory[];
}
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;
[key: string]: any;
}
export interface AdsClipItem {
/**
* Video id
*/
video_id: number;
/**
* Preview url
*/
preview_url: string;
[key: string]: any;
}
export interface AdsClipItemLink {
/**
* Text
*/
text: string;
/**
* Key
*/
key: string;
/**
* Url
*/
url: string;
[key: string]: any;
}
export interface AdsCreateAdStatus {
/**
* Ad ID
*/
id: number;
/**
* Stealth Post ID
*/
post_id: number;
/**
* Error code
*/
error_code: number;
/**
* Error description
*/
error_desc: string;
[key: string]: any;
}
export interface AdsCreateCampaignStatus {
/**
* Campaign ID
*/
id: number;
/**
* Error code
*/
error_code: number;
/**
* Error description
*/
error_desc: string;
[key: string]: any;
}
export interface AdsCreateClientsStatus {
/**
* Client ID
*/
id: number;
/**
* Error code
*/
error_code: number;
/**
* Error description
*/
error_desc: string;
[key: string]: any;
}
export interface AdsCriteria {
/**
* Age from
*/
age_from: string;
/**
* Age to
*/
age_to: string;
/**
* Apps IDs
*/
apps: string;
/**
* Apps IDs to except
*/
apps_not: string;
/**
* Days to birthday
*/
birthday: string;
/**
* Cities IDs
*/
cities: string;
/**
* Cities IDs to except
*/
cities_not: string;
/**
* Country ID
*/
country: string;
/**
* 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: string;
/**
* Positions IDs
*/
positions: string;
/**
* Religions IDs
*/
religions: string;
/**
* Retargeting groups ids
*/
retargeting_groups: string;
/**
* Retargeting groups NOT ids
*/
retargeting_groups_not: string;
/**
* School graduation year from
*/
school_from: string;
/**
* School graduation year to
*/
school_to: string;
/**
* Schools IDs
*/
schools: string;
/**
* Stations IDs
*/
stations: string;
/**
* Relationship statuses
*/
statuses: string;
/**
* Streets IDs
*/
streets: string;
/**
* Travellers
*/
travellers: string;
/**
* AB test
*/
ab_test: string;
/**
* University graduation year from
*/
uni_from: string;
/**
* University graduation year to
*/
uni_to: string;
/**
* Browsers
*/
user_browsers: string;
/**
* Devices
*/
user_devices: string;
/**
* Operating systems
*/
user_os: string;
/**
* Suggested criteria
*/
suggested_criteria: string;
/**
* Group not
*/
groups_not: string;
/**
* Price list audience type
*/
price_list_audience_type: string;
/**
* Count
*/
count: string;
/**
* Group active formula
*/
groups_active_formula: string;
/**
* Interest categories formula
*/
interest_categories_formula: string;
/**
* Groups formula
*/
groups_formula: string;
/**
* Groups active
*/
groups_active: string;
/**
* Group types
*/
group_types: string;
/**
* Key phrases
*/
key_phrases: string;
/**
* Key phrases days
*/
key_phrases_days: string;
/**
* Geo near
*/
geo_near: string;
/**
* Geo point type
*/
geo_point_type: string;
/**
* Price list id
*/
price_list_id: string;
/**
* Groups recommended ids
*/
groups_recommended: string;
/**
* Groups active recommended ids
*/
groups_active_recommended: string;
/**
* Music artists formula
*/
music_artists_formula: string;
/**
* Price list retargeting formula
*/
price_list_retargeting_formula: string;
/**
* Tags
*/
tags: string;
/**
* Browsers
*/
browsers: string;
/**
* Mobile os min version
*/
mobile_os_min_version: string;
/**
* Mobile apps events formula
*/
mobile_apps_events_formula: string;
/**
* Mobile os max version
*/
mobile_os_max_version: string;
/**
* operators
*/
operators: string;
/**
* wifi_only
*/
wifi_only: string;
/**
* mobile_manufacturers
*/
mobile_manufacturers: string;
[key: string]: any;
}
export type AdsCriteriaSex = "0" | "1" | "2";
export interface AdsDemoStats {
/**
* Object ID
*/
id: number;
[key: string]: any;
stats: AdsDemostatsFormat[];
}
export interface AdsDemographicStatsPeriodItemBase {
/**
* Clicks rate
*/
clicks_rate: number;
/**
* Impressions rate
*/
impressions_rate: number;
[key: string]: any;
}
export interface AdsDemostatsFormat {
/**
* Day as YYYY-MM-DD
*/
day: string;
/**
* Month as YYYY-MM
*/
month: string;
/**
* 1 if period=overall
*/
overall: number;
[key: string]: any;
age: AdsStatsAge[];
cities: AdsStatsCities[];
day_from: string;
day_to: string;
sex: AdsStatsSex[];
sex_age: AdsStatsSexAge[];
}
export interface AdsEventsRetargetingGroup {
[key: string]: any;
id: number;
value: number[];
}
export interface AdsFloodStats {
/**
* Requests left
*/
left: number;
/**
* Time to refresh in seconds
*/
refresh: number;
[key: string]: any;
stats_by_user: AdsFloodStatsByUserItem[];
}
export interface AdsFloodStatsByUserItem {
/**
* User ID
*/
user_id: number;
/**
* Used requests
*/
requests_count: number;
[key: string]: any;
}
export interface AdsLinkStatus {
/**
* Reject reason
*/
description: string;
/**
* URL
*/
redirect_url: string;
/**
* Link status
*/
status: string;
[key: string]: any;
}
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: "search_in_progress" | "search_failed" | "search_done" | "save_in_progress" | "save_failed" | "save_done";
/**
* Lookalike request source type
*/
source_type: "retargeting_group";
/**
* 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;
[key: string]: any;
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;
[key: string]: any;
}
export interface AdsMobileStatItem {
[key: string]: any;
key: string;
value: number;
}
export interface AdsMusician {
/**
* Targeting music artist ID
*/
id: number;
/**
* Music artist name
*/
name: string;
/**
* Music artist photo
*/
avatar: string;
[key: string]: any;
}
export type AdsObjectType = "ad" | "campaign" | "client" | "office";
export type AdsOrdClientType = "person" | "individual" | "legal" | "foreign" | "unknown";
export interface AdsOrdData {
[key: string]: any;
client_name: string;
inn: string;
phone: string;
contract_number: string;
contract_date: string;
contract_type: string;
contract_object: string;
with_vat: boolean | number;
}
export interface AdsOrdSubagent {
[key: string]: any;
name: string;
inn: string;
phone: string;
}
export interface AdsPost {
/**
* Post id
*/
id: number;
/**
* From id
*/
from_id: number;
/**
* Owner id
*/
owner_id: number;
/**
* Date
*/
date: number;
/**
* Edited date
*/
edited: number;
/**
* Is pinned
*/
is_pinned: number;
/**
* Marked as ads
*/
marked_as_ads: number;
/**
* Short text rate
*/
short_text_rate: number;
/**
* Type
*/
type: string;
/**
* Is favorite
*/
is_favorite: boolean | number;
/**
* Post type
*/
post_type: string;
/**
* Text
*/
text: string;
/**
* Is promoted post stealth
*/
is_promoted_post_stealth: boolean | number;
/**
* Hash
*/
hash: string;
/**
* Created by
*/
created_by: number;
/**
* Carousel offset
*/
carousel_offset: number;
/**
* Can edit
*/
can_edit: number;
/**
* Can delete
*/
can_delete: number;
/**
* Can pin
*/
can_pin: number;
[key: string]: any;
attachments: WallWallpostAttachment[];
}
export interface AdsPostComments {
/**
* Count
*/
count: number;
[key: string]: any;
}
export interface AdsPostDonut {
/**
* Is donut
*/
is_donut: boolean | number;
[key: string]: any;
}
export interface AdsPostEasyPromote {
/**
* Type
*/
type: number;
/**
* Text
*/
text: string;
/**
* Label text
*/
label_text: string;
/**
* Button text
*/
button_text: string;
/**
* Is ad not easy
*/
is_ad_not_easy: boolean | number;
/**
* Ad id
*/
ad_id: number;
/**
* Top union id
*/
top_union_id: number;
[key: string]: any;
}
export interface AdsPostLikes {
/**
* Can like
*/
can_like: number;
/**
* Count
*/
count: number;
/**
* User likes
*/
user_likes: number;
[key: string]: any;
}
export interface AdsPostOwner {
/**
* Owner id
*/
id: number;
/**
* Name
*/
name: string;
/**
* Photo url
*/
photo: string;
/**
* Profile url
*/
url: string;
[key: string]: any;
}
export interface AdsPostReposts {
/**
* Count
*/
count: number;
/**
* Wall count
*/
wall_count: number;
/**
* Mail count
*/
mail_count: number;
[key: string]: any;
}
export interface AdsPostViews {
/**
* Count
*/
count: number;
[key: string]: any;
}
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 10 seconds
*/
video_views_10s: 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;
/**
* Pretty cards clicks
*/
pretty_cards_clicks: number;
[key: string]: any;
}
export interface AdsRejectReason {
/**
* Comment text
*/
comment: string;
[key: string]: any;
rules: AdsRules[];
}
export interface AdsRules {
/**
* Label
*/
help_label: string;
/**
* Content Html
*/
content_html: string;
/**
* Help chat
*/
help_chat: boolean | number;
[key: string]: any;
}
export type AdsRulesHelpUrl = any;
export interface AdsStatisticClickAction {
[key: string]: any;
type: "load" | "impression" | "click_deeplink" | "click" | "click_post_owner" | "click_post_link" | "click_pretty_card" | "like_post" | "share_post" | "video_start" | "video_pause" | "video_resume" | "video_play_3s" | "video_play_10s" | "video_play_25" | "video_play_50" | "video_play_75" | "video_play_95" | "video_play_100" | "video_volume_on" | "video_volume_off" | "video_fullscreen_on" | "video_fullscreen_off" | "hide";
url: string;
}
export interface AdsStats {
/**
* Object ID
*/
id: number;
[key: string]: any;
stats: AdsStatsFormat[];
}
export interface AdsStatsAge1 {
/**
* Age interval
*/
value: string;
}
export type AdsStatsAge = AdsStatsAge1 & AdsDemographicStatsPeriodItemBase;
export interface AdsStatsCities1 {
/**
* City name
*/
name: string;
}
export type AdsStatsCities = AdsStatsCities1 & AdsDemographicStatsPeriodItemBase;
export interface AdsStatsFormat {
/**
* Clicks number
*/
clicks: number;
/**
* External clicks number
*/
link_external_clicks: number;
/**
* Day as YYYY-MM-DD
*/
day: string;
/**
* Impressions number
*/
impressions: number;
/**
* Events number
*/
join_rate: number;
/**
* Month as YYYY-MM
*/
month: string;
/**
* Year as YYYY
*/
year: number;
/**
* 1 if period=overall
*/
overall: number;
/**
* Reach
*/
reach: number;
/**
* Spent funds
*/
spent: string;
/**
* Video plays unique started count
*/
video_plays_unique_started: number;
/**
* Video plays unique 3 seconds count
*/
video_plays_unique_3_seconds: number;
/**
* Video plays unique 10 seconds count
*/
video_plays_unique_10_seconds: number;
/**
* Video plays unique 25 percents count
*/
video_plays_unique_25_percents: number;
/**
* Video plays unique 50 percents count
*/
video_plays_unique_50_percents: number;
/**
* Video plays unique 75 percents count
*/
video_plays_unique_75_percents: number;
/**
* Video plays unique 100 percents count
*/
video_plays_unique_100_percents: number;
/**
* Effective cost per click
*/
effective_cost_per_click: string;
/**
* Effective cost per mille
*/
effective_cost_per_mille: string;
/**
* Effective cpf
*/
effective_cpf: string;
/**
* Effective cost per message
*/
effective_cost_per_message: string;
/**
* Message sends count
*/
message_sends: number;
/**
* Message sends by anu user
*/
message_sends_by_any_user: number;
/**
* Conversions external
*/
conversions_external: number;
/**
* Conversions count
*/
conversion_count: number;
/**
* Conversions CR
*/
conversion_cr: string;
/**
* Day from
*/
day_from: string;
/**
* Day to
*/
day_to: string;
/**
* Ctr
*/
ctr: string;
/**
* Unique views count
*/
uniq_views_count: number;
[key: string]: any;
mobile_app_stat: AdsMobileStatItem[];
}
export interface AdsStatsSex1 {
value: AdsStatsSexValue;
}
export type AdsStatsSex = AdsStatsSex1 & AdsDemographicStatsPeriodItemBase;
export interface AdsStatsSexAge1 {
/**
* Sex and age interval
*/
value: string;
}
export type AdsStatsSexAge = AdsStatsSexAge1 & AdsDemographicStatsPeriodItemBase;
export type AdsStatsSexValue = "f" | "m";
export interface AdsStatsViewsTimes {
[key: string]: any;
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 AdsStories {
/**
* Stories disclaimers text
*/
stories_disclaimers_text: string;
[key: string]: any;
stories: AdsStoryItem[];
}
export interface AdsStoriesOwner {
/**
* Owner id
*/
id: number;
/**
* Href
*/
href: string;
/**
* Name
*/
name: string;
/**
* Photo
*/
photo: string;
/**
* Verify
*/
verify: string;
/**
* Gender
*/
gender: string;
/**
* Name get
*/
name_get: string;
/**
* First name
*/
firstName: string;
/**
* First name gen
*/
first_name_gen: string;
/**
* First name ins
*/
first_name_ins: string;
/**
* Can follow
*/
can_follow: boolean | number;
[key: string]: any;
}
export interface AdsStoryItem {
/**
* Story id
*/
id: number;
/**
* Owner id
*/
owner_id: number;
/**
* Story raw id
*/
raw_id: string;
/**
* Date
*/
date: string;
/**
* Time
*/
time: number;
/**
* Type
*/
type: string;
/**
* Is unread
*/
unread: boolean | number;
/**
* Can like
*/
canLike: boolean | number;
/**
* Can comment
*/
can_comment: boolean | number;
/**
* Can share
*/
can_share: boolean | number;
/**
* Can remove
*/
can_remove: boolean | number;
/**
* Can manage
*/
can_manage: boolean | number;
/**
* Can ask
*/
can_ask: boolean | number;
/**
* Can ask anonymous
*/
can_ask_anonymous: boolean | number;
/**
* Is profile question
*/
isProfileQuestion: boolean | number;
/**
* Photo url
*/
photo_url: string;
/**
* Preview url
*/
preview_url: string;
/**
* Track code
*/
track_code: string;
/**
* Is part of narrative
*/
isPartOfNarrative: boolean | number;
/**
* Is ads
*/
isAds: boolean | number;
/**
* Video url
*/
video_url: string;
/**
* First frame
*/
first_frame: string;
/**
* Small preview
*/
small_preview: string;
/**
* Is liked
*/
isLiked: boolean | number;
[key: string]: any;
}
export interface AdsStoryItemLink {
/**
* Key
*/
key: string;
/**
* Text
*/
text: string;
/**
* Url
*/
url: string;
/**
* Raw url
*/
raw_url: string;
[key: string]: any;
}
export interface AdsStoryItemStats {
[key: string]: any;
}
export interface AdsStoryItemStatsFollow {
/**
* Event type
*/
event_type: string;
/**
* Event hash
*/
rhash: string;
[key: string]: any;
}
export interface AdsStoryItemStatsUrlView {
/**
* Event type
*/
event_type: string;
/**
* Event hash
*/
rhash: string;
[key: string]: any;
}
export interface AdsTargSettings1 {
/**
* Ad ID
*/
id: string;
/**
* Campaign ID
*/
campaign_id: string;
}
export type AdsTargSettings = AdsTargSettings1 & AdsCriteria;
export interface AdsTargStats {
/**
* Audience
*/
audience_count: number;
/**
* Recommended CPC value for 50% reach (old format)
*/
recommended_cpc: string;
/**
* Recommended CPM value for 50% reach (old format)
*/
recommended_cpm: string;
/**
* Recommended CPC value for 50% reach
*/
recommended_cpc_50: string;
/**
* Recommended CPM value for 50% reach
*/
recommended_cpm_50: string;
/**
* Recommended CPC value for 70% reach
*/
recommended_cpc_70: string;
/**
* Recommended CPM value for 70% reach
*/
recommended_cpm_70: string;
/**
* Recommended CPC value for 90% reach
*/
recommended_cpc_90: string;
/**
* Recommended CPM value for 90% reach
*/
recommended_cpm_90: string;
/**
* Total alive audience
*/
total_alive_audience: number;
[key: string]: any;
}
export interface AdsTargSuggestions {
/**
* Object ID
*/
id: number;
/**
* Object name
*/
name: string;
/**
* Object type
*/
type: string;
/**
* Parent
*/
parent: string;
[key: string]: any;
}
export interface AdsTargSuggestionsCities {
/**
* Object ID
*/
id: number;
/**
* Object name
*/
name: string;
/**
* Parent object
*/
parent: string;
[key: string]: any;
}
export interface AdsTargSuggestionsRegions {
/**
* Object ID
*/
id: number;
/**
* Object name
*/
name: string;
/**
* Object type
*/
type: string;
[key: string]: any;
}
export interface AdsTargSuggestionsSchools {
/**
* Full school title
*/
desc: string;
/**
* School ID
*/
id: number;
/**
* School title
*/
name: string;
/**
* City name
*/
parent: string;
[key: string]: any;
}
export type AdsTargSuggestionsSchoolsType = "school" | "university" | "faculty" | "chair";
export interface AdsTargetGroup {
/**
* Group ID
*/
id: number;
/**
* Group name
*/
name: string;
/**
* Is audience
*/
is_audience: boolean | number;
/**
* Is shared
*/
is_shared: boolean | number;
/**
* File source
*/
file_source: boolean | number;
/**
* API source
*/
api_source: boolean | number;
/**
* File source
*/
lookalike_source: boolean | number;
/**
* Audience
*/
audience_count: number;
/**
* Site domain
*/
domain: string;
/**
* Number of days for user to be in group
*/
lifetime: number;
/**
* Pixel code
*/
pixel: string;
/**
* Target Pixel id
*/
target_pixel_id: number;
/**
* Last updated
*/
last_updated: number;
[key: string]: any;
target_pixel_rules: AdsTargetGroupTargetPixelRule[];
}
export interface AdsTargetGroupTargetPixelRule {
[key: string]: any;
url_full_match: string;
event_full_match: string;
url_substrings_match: string[];
event_substrings_match: string[];
url_regex_match: string;
event_regex_match: string;
}
export interface AdsTargetPixelInfo {
[key: string]: any;
target_pixel_id: number;
name: string;
domain: string;
category_id: number;
last_updated: number;
pixel: string;
}
export interface AdsUpdateOfficeUsersResult {
[key: string]: any;
user_id: number;
is_success: boolean | number;
}
export interface AdsUpdateAdsStatus {
/**
* Ad ID
*/
id: number;
/**
* Error code
*/
error_code: number;
/**
* Error description
*/
error_desc: string;
[key: string]: any;
}
export interface AdsUpdateClientsStatus {
/**
* Client ID
*/
id: number;
/**
* Error code
*/
error_code: number;
/**
* Error description
*/
error_desc: string;
[key: string]: any;
}
export interface AdsUserSpecification {
[key: string]: any;
user_id: number;
grant_access_to_all_clients: boolean | number;
client_ids: number[];
view_budget: boolean | number;
}
export interface AdsUserSpecificationCutted {
[key: string]: any;
user_id: number;
client_id: number;
view_budget: boolean | number;
}
export interface AdsUsers {
/**
* User ID
*/
user_id: number;
[key: string]: any;
accesses: AdsAccesses[];
}
export interface AdswebGetAdCategoriesResponseCategoriesCategory {
[key: string]: any;
id: number;
name: string;
}
export interface AdswebGetAdUnitsResponseAdUnitsAdUnit {
[key: string]: any;
id: number;
site_id: number;
name: string;
}
export interface AdswebGetFraudHistoryResponseEntriesEntry {
[key: string]: any;
site_id: number;
day: string;
}
export interface AdswebGetSitesResponseSitesSite {
[key: string]: any;
id: number;
status_user: string;
status_moder: string;
domains: string;
}
export interface AdswebGetStatisticsResponseItemsItem {
[key: string]: any;
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 AppsApp1 {
/**
* 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;
/**
* 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 | number;
/**
* Information whether application is in mobile catalog
*/
is_in_catalog: number;
/**
* 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;
is_new: BaseBoolInt;
push_enabled: BaseBoolInt;
friends: number[];
leaderboard_type: AppsAppLeaderboardType;
}
export type AppsApp = AppsAppMin & AppsApp1;
export type AppsAppFields = "author_group" | "author_id" | "author_url" | "banner_1120" | "banner_560" | "banner_186" | "banner_896" | "icon_16" | "icon_25" | "icon_50" | "icon_100" | "icon_200" | "icon_128" | "icon_256" | "is_new" | "new" | "is_html5_app" | "push_enabled" | "catalog_banner" | "friends" | "catalog_position" | "description" | "genre" | "genre_id" | "international" | "is_in_catalog" | "installed" | "leaderboard_type" | "members_count" | "platform_id" | "published_date" | "screen_name" | "section" | "type" | "id" | "title" | "author_owner_id" | "is_installed" | "icon_139" | "icon_150" | "icon_278" | "icon_576" | "background_loader_color" | "loader_icon" | "icon_75" | "open_in_external_browser" | "ad_config" | "screen_orientation";
export type AppsAppLeaderboardType = 0 | 1 | 2;
export interface AppsAppMin {
/**
* Application ID
*/
id: number;
/**
* Application title
*/
title: string;
/**
* Application author's ID
*/
author_owner_id: number;
/**
* Is application installed
*/
is_installed: boolean | number;
/**
* 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;
/**
* Screen orientation
*/
screen_orientation: number;
[key: string]: any;
}
export type AppsAppType = "app" | "game" | "site" | "standalone" | "vk_app" | "community_app" | "html5_game" | "mini_app";
export interface AppsCatalogList {
/**
* Total number
*/
count: number;
[key: string]: any;
items: AppsApp[];
profiles: UsersUserMin[];
}
export interface AppsLeaderboard {
/**
* Level
*/
level: number;
/**
* Points number
*/
points: number;
/**
* Score number
*/
score: number;
/**
* User ID
*/
user_id: number;
[key: string]: any;
}
export interface AppsScope {
/**
* Scope name
*/
name: "friends" | "photos" | "video" | "pages" | "status" | "notes" | "wall" | "docs" | "groups" | "stats" | "market" | "stories" | "app_widget" | "messages" | "manage" | "notify" | "audio" | "support" | "menu" | "wallmenu" | "ads" | "offline" | "notifications" | "email" | "adsweb" | "leads" | "group_messages" | "exchange" | "phone";
/**
* Scope title
*/
title: string;
[key: string]: any;
}
export interface AppsTestingGroup {
[key: string]: any;
user_ids: number[];
group_id: number;
name: string;
webview: string;
platforms: ("mobile" | "web" | "mvk")[];
}
export interface AppWidgetsPhoto {
/**
* Image ID
*/
id: string;
[key: string]: any;
images: BaseImage[];
}
export interface AppWidgetsPhotos {
[key: string]: any;
count: number;
items: AppWidgetsPhoto[];
}
export interface AsrTask {
/**
* Task ID in UUID format.
*/
id: string;
/**
* Status of the task.
*/
status: "processing" | "finished" | "internal_error" | "transcoding_error" | "recognition_error";
/**
* Recognised text, if task is `finished`.
*/
text: string;
[key: string]: any;
}
export interface AudioAudio {
/**
* Access key for the audio
*/
access_key: string;
/**
* Artist name
*/
artist: string;
/**
* Audio ID
*/
id: number;
/**
* Audio owner's ID
*/
owner_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;
/**
* Performer name
*/
performer: string;
[key: string]: any;
}
export type BaseBoolInt = 0 | 1;
export interface BaseCity {
/**
* City ID
*/
id: number;
/**
* City title
*/
title: string;
[key: string]: any;
}
export interface BaseCommentsInfo {
/**
* Comments number
*/
count: number;
/**
* Information whether groups can comment the post
*/
groups_can_post: boolean | number;
[key: string]: any;
list: WallWallComment[];
}
export interface BaseCountry {
/**
* Country ID
*/
id: number;
/**
* Country title
*/
title: string;
[key: string]: any;
}
export interface BaseCropPhoto {
[key: string]: any;
}
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;
[key: string]: any;
}
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;
[key: string]: any;
}
export interface BaseError {
/**
* Error code
*/
error_code: number;
/**
* Error subcode
*/
error_subcode: number;
/**
* Error message
*/
error_msg: string;
/**
* Localized error message
*/
error_text: string;
[key: string]: any;
request_params: BaseRequestParam[];
}
export interface BaseGeo {
/**
* Information whether a map is showed
*/
showmap: number;
/**
* Place type
*/
type: string;
[key: string]: any;
}
export interface BaseGeoCoordinates {
[key: string]: any;
latitude: number;
longitude: number;
}
export interface BaseGradientPoint {
/**
* Hex color code without #
*/
color: string;
/**
* Point position
*/
position: number;
[key: string]: any;
}
export interface BaseImage {
/**
* Image url
*/
url: string;
/**
* Image width
*/
width: number;
/**
* Image height
*/
height: number;
[key: string]: any;
id: string;
theme: "light" | "dark";
}
export type BaseLang = "ru" | "ua" | "be" | "en" | "es" | "fi" | "de" | "it";
export interface BaseLikes {
/**
* Likes number
*/
count: number;
[key: string]: any;
}
export interface BaseLikesInfo {
/**
* Likes number
*/
count: number;
/**
* Remove repost feature for post
*/
repost_disabled: boolean | number;
[key: string]: any;
}
export interface BaseLink1 {
text: string;
product: BaseLinkProduct;
}
export type BaseLink = BaseLinkNoProduct & BaseLink1;
export interface BaseLinkApplication {
/**
* Application Id
*/
app_id: number;
[key: string]: any;
}
export interface BaseLinkApplicationStore {
/**
* Store Id
*/
id: number;
/**
* Store name
*/
name: string;
[key: string]: any;
}
export interface BaseLinkButton {
/**
* Button title
*/
title: string;
/**
* Target block id
*/
block_id: string;
/**
* Target section id
*/
section_id: string;
/**
* artist id
*/
artist_id: string;
/**
* curator id
*/
curator_id: number;
/**
* Video album id
*/
album_id: number;
/**
* Owner id
*/
owner_id: number;
/**
* Button icon name, e.g. 'phone' or 'gift'
*/
icon: string;
[key: string]: any;
audio_id: number;
hashtag: string;
}
export interface BaseLinkButtonAction {
/**
* Action URL
*/
url: string;
[key: string]: any;
consume_reason: string;
}
export type BaseLinkButtonActionType = "open_url" | "market_clear_recent_queries" | "close_web_app" | "open_search_tab" | "import_contacts" | "add_friends" | "onboarding";
export type BaseLinkButtonStyle = "primary" | "secondary";
export interface BaseLinkNoProduct {
/**
* Link caption
*/
caption: string;
/**
* Link description
*/
description: string;
/**
* Link ID
*/
id: string;
/**
* String ID of the page with article preview
*/
preview_page: string;
/**
* URL of the page with article preview
*/
preview_url: string;
/**
* Link title
*/
title: string;
/**
* Link URL
*/
url: string;
/**
* Information whether the current link is external
*/
is_external: boolean | number;
[key: string]: any;
is_favorite: boolean | number;
}
export interface BaseLinkProduct {
[key: string]: any;
merchant: string;
distance: number;
city: string;
orders_count: number;
type: "product";
}
export type BaseLinkProductCategory = any;
export type BaseLinkProductStatus = "active" | "blocked" | "sold" | "deleted" | "archived";
export interface BaseLinkRating {
/**
* Count of reviews
*/
reviews_count: number;
/**
* Count of stars
*/
stars: number;
[key: string]: any;
type: "rating";
}
export interface BaseMessageError {
/**
* Error code
*/
code: number;
/**
* Error message
*/
description: string;
[key: string]: any;
}
export type BaseNameCase = "Nom" | "Gen" | "Dat" | "Acc" | "Ins" | "Abl";
export interface BaseObject {
/**
* Object ID
*/
id: number;
/**
* Object title
*/
title: string;
[key: string]: any;
}
export interface BaseObjectCount {
/**
* Items count
*/
count: number;
[key: string]: any;
}
export interface BaseObjectWithName {
/**
* Object ID
*/
id: nu