node-vk-sdk/src/generated/MethodsProps.ts

VK API SDK for Node.js

import * as Models from "./Models"

export interface AccountBanParams {
    /**
     * undefined
     */
    owner_id?: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountGetActiveOffersParams {
    /**
     * undefined
     */
    offset?: number,
    /**
     * Number of results to return.
     */
    count?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountGetAppPermissionsParams {
    /**
     * User ID whose settings information shall be got. By default: current user.
     */
    user_id: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountGetBannedParams {
    /**
     * Offset needed to return a specific subset of results.
     */
    offset?: number,
    /**
     * Number of results to return.
     */
    count?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountGetCountersParams {
    /**
     * Counters to be returned.
     */
    filter?: string[],
    /**
     * access token
     */
    access_token?: string
}

export interface AccountGetInfoParams {
    /**
     * Fields to return. Possible values: *'country' — user country,, *'https_required' — is "HTTPS only" option enabled,, *'own_posts_default' — is "Show my posts only" option is enabled,, *'no_wall_replies' — are wall replies disabled or not,, *'intro' — is intro passed by user or not,, *'lang' — user language. By default: all.
     */
    fields?: string[],
    /**
     * access token
     */
    access_token?: string
}

export interface AccountGetProfileInfoParams {
    /**
     * access token
     */
    access_token?: string
}

export interface AccountGetPushSettingsParams {
    /**
     * Unique device ID.
     */
    device_id?: string,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * undefined
     */
    sandbox?: boolean,
    /**
     * access token
     */
    access_token?: string
}

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?: number,
    /**
     * 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?: number,
    /**
     * 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?: number,
    /**
     * User home town.
     */
    home_town?: string,
    /**
     * User country.
     */
    country_id?: number,
    /**
     * User city.
     */
    city_id?: number,
    /**
     * Status text.
     */
    status?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountSetInfoParams {
    /**
     * Setting name.
     */
    name?: string,
    /**
     * Setting value.
     */
    value?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountSetNameInMenuParams {
    /**
     * User ID.
     */
    user_id: number,
    /**
     * Application screen name.
     */
    name?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountSetOfflineParams {
    /**
     * access token
     */
    access_token?: string
}

export interface AccountSetOnlineParams {
    /**
     * '1' if videocalls are available for current device.
     */
    voip?: boolean,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * New value for the key in a [vk.com/dev/push_settings|special format].
     */
    value?: string[],
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountUnbanParams {
    /**
     * undefined
     */
    owner_id?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AccountUnregisterDeviceParams {
    /**
     * Unique device ID.
     */
    device_id?: string,
    /**
     * undefined
     */
    sandbox?: boolean,
    /**
     * access token
     */
    access_token?: string
}

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: Models.AdsUserSpecificationCutted[],
    /**
     * access token
     */
    access_token?: string
}

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: string,
    /**
     * Object URL.
     */
    link_url: string,
    /**
     * Campaign ID
     */
    campaign_id?: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * undefined
     */
    target_pixel_id?: number,
    /**
     * undefined
     */
    target_pixel_rules?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsDeleteAdsParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * Serialized JSON array with ad IDs.
     */
    ids: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsDeleteCampaignsParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * Serialized JSON array with IDs of deleted campaigns.
     */
    ids: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsDeleteClientsParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * Serialized JSON array with IDs of deleted clients.
     */
    ids: string,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetAccountsParams {
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * 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,
    /**
     * 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,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetAdsLayoutParams {
    /**
     * 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,
    /**
     * 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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * 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,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetBudgetParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * 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,
    /**
     * undefined
     */
    fields?: string[],
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetCategoriesParams {
    /**
     * Language. The full list of supported languages is [vk.com/dev/api_requests|here].
     */
    lang?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetClientsParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetDemographicsParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * Type of requested objects listed in 'ids' parameter: *ad — ads,, *campaign — campaigns.
     */
    ids_type: string,
    /**
     * 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: string,
    /**
     * 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,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetFloodStatsParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetLookalikeRequestsParams {
    /**
     * undefined
     */
    account_id: number,
    /**
     * undefined
     */
    client_id?: number,
    /**
     * undefined
     */
    requests_ids?: string,
    /**
     * undefined
     */
    offset?: number,
    /**
     * undefined
     */
    limit?: number,
    /**
     * undefined
     */
    sort_by?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetMusiciansParams {
    /**
     * undefined
     */
    artist_name: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetOfficeUsersParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetPostsReachParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * Type of requested objects listed in 'ids' parameter: *ad — ads,, *campaign — campaigns.
     */
    ids_type: string,
    /**
     * IDs requested ads or campaigns, separated with a comma, depending on the value set in 'ids_type'. Maximum 100 objects.
     */
    ids: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetRejectionReasonParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * Ad ID.
     */
    ad_id: number,
    /**
     * access token
     */
    access_token?: string
}

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: string,
    /**
     * 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: string,
    /**
     * 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,
    /**
     * Additional fields to add to statistics
     */
    stats_fields?: string[],
    /**
     * access token
     */
    access_token?: string
}

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: string,
    /**
     * 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,
    /**
     * Language of the returned string values. Supported languages: *ru — Russian,, *ua — Ukrainian,, *en — English.
     */
    lang?: string,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetTargetingStatsParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * undefined
     */
    client_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?: number,
    /**
     * 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,
    /**
     * undefined
     */
    ad_platform_no_wall?: string,
    /**
     * undefined
     */
    ad_platform_no_ad_network?: 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,
    /**
     * Impressions limit period in seconds, must be a multiple of 86400(day)
     */
    impressions_limit_period?: number,
    /**
     * access token
     */
    access_token?: string
}

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: number,
    /**
     * undefined
     */
    icon?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsGetVideoUploadURLParams {
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface AdsRemoveOfficeUsersParams {
    /**
     * Advertising account ID.
     */
    account_id: number,
    /**
     * Serialized JSON array with IDs of deleted managers.
     */
    ids: string,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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: Models.AdsUserSpecification[],
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * undefined
     */
    target_pixel_id?: number,
    /**
     * undefined
     */
    target_pixel_rules?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AdswebGetAdCategoriesParams {
    /**
     * undefined
     */
    office_id: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AdswebGetAdUnitCodeParams {
    /**
     * access token
     */
    access_token?: string
}

export interface AdswebGetAdUnitsParams {
    /**
     * undefined
     */
    office_id: number,
    /**
     * undefined
     */
    sites_ids?: string,
    /**
     * undefined
     */
    ad_units_ids?: string,
    /**
     * undefined
     */
    fields?: string,
    /**
     * undefined
     */
    limit?: number,
    /**
     * undefined
     */
    offset?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AdswebGetFraudHistoryParams {
    /**
     * undefined
     */
    office_id: number,
    /**
     * undefined
     */
    sites_ids?: string,
    /**
     * undefined
     */
    limit?: number,
    /**
     * undefined
     */
    offset?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AdswebGetSitesParams {
    /**
     * undefined
     */
    office_id: number,
    /**
     * undefined
     */
    sites_ids?: string,
    /**
     * undefined
     */
    fields?: string,
    /**
     * undefined
     */
    limit?: number,
    /**
     * undefined
     */
    offset?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AdswebGetStatisticsParams {
    /**
     * undefined
     */
    office_id: number,
    /**
     * undefined
     */
    ids_type: string,
    /**
     * undefined
     */
    ids: string,
    /**
     * undefined
     */
    period: string,
    /**
     * undefined
     */
    date_from: string,
    /**
     * undefined
     */
    date_to: string,
    /**
     * undefined
     */
    fields?: string,
    /**
     * undefined
     */
    limit?: number,
    /**
     * undefined
     */
    page_id?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppWidgetsGetAppImageUploadServerParams {
    /**
     * undefined
     */
    image_type: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppWidgetsGetAppImagesParams {
    /**
     * Offset needed to return a specific subset of images.
     */
    offset?: number,
    /**
     * Maximum count of results.
     */
    count?: number,
    /**
     * undefined
     */
    image_type?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppWidgetsGetGroupImageUploadServerParams {
    /**
     * undefined
     */
    image_type: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppWidgetsGetGroupImagesParams {
    /**
     * Offset needed to return a specific subset of images.
     */
    offset?: number,
    /**
     * Maximum count of results.
     */
    count?: number,
    /**
     * undefined
     */
    image_type?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppWidgetsGetImagesByIdParams {
    /**
     * List of images IDs
     */
    images: string[],
    /**
     * access token
     */
    access_token?: string
}

export interface AppWidgetsSaveAppImageParams {
    /**
     * Parameter returned when photo is uploaded to server
     */
    hash: string,
    /**
     * Parameter returned when photo is uploaded to server
     */
    image: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppWidgetsSaveGroupImageParams {
    /**
     * Parameter returned when photo is uploaded to server
     */
    hash: string,
    /**
     * Parameter returned when photo is uploaded to server
     */
    image: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppWidgetsUpdateParams {
    /**
     * undefined
     */
    code: string,
    /**
     * undefined
     */
    type: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppsDeleteAppRequestsParams {
    /**
     * access token
     */
    access_token?: string
}

export interface AppsGetParams {
    /**
     * Application ID
     */
    app_id?: number,
    /**
     * List of application ID
     */
    app_ids?: string[],
    /**
     * platform. Possible values: *'ios' — iOS,, *'android' — Android,, *'winphone' — Windows Phone,, *'web' — приложения на vk.com. By default: 'web'.
     */
    platform?: string,
    /**
     * undefined
     */
    extended?: boolean,
    /**
     * undefined
     */
    return_friends?: boolean,
    /**
     * Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities', (only if return_friends - 1)
     */
    fields?: Models.UsersFields[],
    /**
     * Case for declension of user name and surname: 'nom' — nominative (default),, 'gen' — genitive,, 'dat' — dative,, 'acc' — accusative,, 'ins' — instrumental,, 'abl' — prepositional. (only if 'return_friends' = '1')
     */
    name_case?: string,
    /**
     * access token
     */
    access_token?: string
}

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?: string,
    /**
     * Offset required to return a specific subset of apps.
     */
    offset?: number,
    /**
     * Number of apps to return.
     */
    count: number,
    /**
     * undefined
     */
    platform?: string,
    /**
     * '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,
    /**
     * undefined
     */
    return_friends?: boolean,
    /**
     * undefined
     */
    fields?: Models.UsersFields[],
    /**
     * undefined
     */
    name_case?: string,
    /**
     * Search query string.
     */
    q?: string,
    /**
     * undefined
     */
    genre_id?: number,
    /**
     * 'installed' — to return list of installed apps (only for mobile platform).
     */
    filter?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppsGetFriendsListParams {
    /**
     * undefined
     */
    extended?: boolean,
    /**
     * List size.
     */
    count?: number,
    /**
     * undefined
     */
    offset?: 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?: string,
    /**
     * Additional profile fields, see [vk.com/dev/fields|description].
     */
    fields?: Models.UsersFields[],
    /**
     * access token
     */
    access_token?: string
}

export interface AppsGetLeaderboardParams {
    /**
     * Leaderboard type. Possible values: *'level' — by level,, *'points' — by mission points,, *'score' — by score ().
     */
    type: string,
    /**
     * Rating type. Possible values: *'1' — global rating among all players,, *'0' — rating among user friends.
     */
    global?: boolean,
    /**
     * 1 — to return additional info about users
     */
    extended?: boolean,
    /**
     * access token
     */
    access_token?: string
}

export interface AppsGetScopesParams {
    /**
     * undefined
     */
    type?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface AppsGetScoreParams {
    /**
     * undefined
     */
    user_id: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AppsPromoHasActiveGiftParams {
    /**
     * Id of game promo action
     */
    promo_id: number,
    /**
     * undefined
     */
    user_id?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface AppsPromoUseGiftParams {
    /**
     * Id of game promo action
     */
    promo_id: number,
    /**
     * undefined
     */
    user_id?: number,
    /**
     * access token
     */
    access_token?: string
}

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?: string,
    /**
     * undefined
     */
    name?: string,
    /**
     * special string key to be sent with the request
     */
    key?: string,
    /**
     * undefined
     */
    separate?: boolean,
    /**
     * access token
     */
    access_token?: string
}

export interface AuthRestoreParams {
    /**
     * User phone number.
     */
    phone: string,
    /**
     * User last name.
     */
    last_name: string,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * List of media objects attached to the topic, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", '' — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media owner. '<media_id>' — Media ID. Example: "photo100172_166443618,photo66748_265827614", , "NOTE: If you try to attach more than one reference, an error will be thrown.",
     */
    attachments?: string[],
    /**
     * access token
     */
    access_token?: string
}

export interface BoardCloseTopicParams {
    /**
     * ID of the community that owns the discussion board.
     */
    group_id: number,
    /**
     * Topic ID.
     */
    topic_id: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * (Required if 'text' is not set.) List of media objects attached to the comment, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", '' — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media owner. '<media_id>' — Media ID.
     */
    attachments?: string[],
    /**
     * '1' — to post the comment as by the community, '0' — to post the comment as by the user (default)
     */
    from_group?: boolean,
    /**
     * Sticker ID.
     */
    sticker_id?: number,
    /**
     * Unique identifier to avoid repeated comments.
     */
    guid?: string,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface BoardDeleteTopicParams {
    /**
     * ID of the community that owns the discussion board.
     */
    group_id: number,
    /**
     * Topic ID.
     */
    topic_id: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * (Required if 'message' is not set.) List of media objects attached to the comment, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", '' — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media owner. '<media_id>' — Media ID. Example: "photo100172_166443618,photo66748_265827614"
     */
    attachments?: string[],
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface BoardFixTopicParams {
    /**
     * ID of the community that owns the discussion board.
     */
    group_id: number,
    /**
     * Topic ID.
     */
    topic_id: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * undefined
     */
    start_comment_id?: 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,
    /**
     * Sort order: 'asc' — by creation date in chronological order, 'desc' — by creation date in reverse chronological order,
     */
    sort?: string,
    /**
     * access token
     */
    access_token?: string
}

export interface BoardGetTopicsParams {
    /**
     * ID of the community that owns the discussion board.
     */
    group_id: number,
    /**
     * IDs of topics to be returned (100 maximum). By default, all topics are returned. If this parameter is set, the 'order', 'offset', and 'count' parameters are ignored.
     */
    topic_ids?: 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?: number,
    /**
     * 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,
    /**
     * '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?: number,
    /**
     * Number of characters after which to truncate the previewed comment. To preview the full comment, specify '0'.
     */
    preview_length?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface BoardOpenTopicParams {
    /**
     * ID of the community that owns the discussion board.
     */
    group_id: number,
    /**
     * Topic ID.
     */
    topic_id: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface BoardUnfixTopicParams {
    /**
     * ID of the community that owns the discussion board.
     */
    group_id: number,
    /**
     * Topic ID.
     */
    topic_id: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * Offset needed to return a specific subset of cities.
     */
    offset?: number,
    /**
     * Number of cities to return.
     */
    count?: number,
    /**
     * access token
     */
    access_token?: string
}

export interface DatabaseGetCitiesByIdParams {
    /**
     * City IDs.
     */
    city_ids?: number[],
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * 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,
    /**
     * access token
     */
    access_token?: string
}

export interface DatabaseGetCountriesByIdParams {
    /**
     * Country IDs.
     */
    country_ids?: number[],
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface DatabaseGetMetroStationsParams {
    /**
     * undefined
     */
    city_id: number,
    /**
     * undefined
     */
    offset?: number,
    /**
     * undefined
     */
    count?: number,
    /**
     * undefined
     */
    extended?: boolean,
    /**
     * access token
     */
    access_token?: string
}

export interface DatabaseGetMetroStationsByIdParams {
    /**
     * undefined
     */
    station_ids?: number[],
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

export interface DatabaseGetSchoolClassesParams {
    /**
     * Country ID.
     */
    country_id?: number,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * access token
     */
    access_token?: string
}

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,
    /**
     * Document tags.
     */
    tags?: string[],
    /**
     * access token
     */
    access_token?: string
}

export interface DocsGetParams {
    /**
     * Number of documents to return. By defa