googleapis/build/src/apis/gamesConfiguration/v1configuration.d.ts

Google APIs Client Library for Node.js

/**
 * Copyright 2015 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { AxiosPromise } from 'axios';
import { GoogleApis } from '../..';
import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api';
/**
 * Google Play Game Services Publishing API
 *
 * The Publishing API for Google Play Game Services.
 *
 * @example
 * const google = require('googleapis');
 * const gamesConfiguration = google.gamesConfiguration('v1configuration');
 *
 * @namespace gamesConfiguration
 * @type {Function}
 * @version v1configuration
 * @variation v1configuration
 * @param {object=} options Options for Gamesconfiguration
 */
export declare class Gamesconfiguration {
    _options: GlobalOptions;
    google: GoogleApis;
    root: this;
    achievementConfigurations: Resource$Achievementconfigurations;
    imageConfigurations: Resource$Imageconfigurations;
    leaderboardConfigurations: Resource$Leaderboardconfigurations;
    constructor(options: GlobalOptions, google: GoogleApis);
    getRoot(): this;
}
/**
 * This is a JSON template for an achievement configuration resource.
 */
export interface Schema$AchievementConfiguration {
    /**
     * The type of the achievement. Possible values are:   - "STANDARD"
     * - Achievement is either locked or unlocked.  - "INCREMENTAL" -
     * Achievement is incremental.
     */
    achievementType: string;
    /**
     * The draft data of the achievement.
     */
    draft: Schema$AchievementConfigurationDetail;
    /**
     * The ID of the achievement.
     */
    id: string;
    /**
     * The initial state of the achievement. Possible values are:   -
     * "HIDDEN" - Achievement is hidden.  - "REVEALED" -
     * Achievement is revealed.  - "UNLOCKED" - Achievement is unlocked.
     */
    initialState: string;
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string gamesConfiguration#achievementConfiguration.
     */
    kind: string;
    /**
     * The read-only published data of the achievement.
     */
    published: Schema$AchievementConfigurationDetail;
    /**
     * Steps to unlock. Only applicable to incremental achievements.
     */
    stepsToUnlock: number;
    /**
     * The token for this resource.
     */
    token: string;
}
/**
 * This is a JSON template for an achievement configuration detail.
 */
export interface Schema$AchievementConfigurationDetail {
    /**
     * Localized strings for the achievement description.
     */
    description: Schema$LocalizedStringBundle;
    /**
     * The icon url of this achievement. Writes to this field are ignored.
     */
    iconUrl: string;
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string gamesConfiguration#achievementConfigurationDetail.
     */
    kind: string;
    /**
     * Localized strings for the achievement name.
     */
    name: Schema$LocalizedStringBundle;
    /**
     * Point value for the achievement.
     */
    pointValue: number;
    /**
     * The sort rank of this achievement. Writes to this field are ignored.
     */
    sortRank: number;
}
/**
 * This is a JSON template for a ListConfigurations response.
 */
export interface Schema$AchievementConfigurationListResponse {
    /**
     * The achievement configurations.
     */
    items: Schema$AchievementConfiguration[];
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string games#achievementConfigurationListResponse.
     */
    kind: string;
    /**
     * The pagination token for the next page of results.
     */
    nextPageToken: string;
}
/**
 * This is a JSON template for a number affix resource.
 */
export interface Schema$GamesNumberAffixConfiguration {
    /**
     * When the language requires special treatment of "small" numbers
     * (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13,
     * or 14 in Polish).
     */
    few: Schema$LocalizedStringBundle;
    /**
     * When the language requires special treatment of "large" numbers
     * (as with numbers ending 11-99 in Maltese).
     */
    many: Schema$LocalizedStringBundle;
    /**
     * When the language requires special treatment of numbers like one (as with
     * the number 1 in English and most other languages; in Russian, any number
     * ending in 1 but not ending in 11 is in this class).
     */
    one: Schema$LocalizedStringBundle;
    /**
     * When the language does not require special treatment of the given quantity
     * (as with all numbers in Chinese, or 42 in English).
     */
    other: Schema$LocalizedStringBundle;
    /**
     * When the language requires special treatment of numbers like two (as with 2
     * in Welsh, or 102 in Slovenian).
     */
    two: Schema$LocalizedStringBundle;
    /**
     * When the language requires special treatment of the number 0 (as in
     * Arabic).
     */
    zero: Schema$LocalizedStringBundle;
}
/**
 * This is a JSON template for a number format resource.
 */
export interface Schema$GamesNumberFormatConfiguration {
    /**
     * The curreny code string. Only used for CURRENCY format type.
     */
    currencyCode: string;
    /**
     * The formatting for the number. Possible values are:   - "NUMERIC"
     * - Numbers are formatted to have no digits or a fixed number of digits after
     * the decimal point according to locale. An optional custom unit can be
     * added. - "TIME_DURATION" - Numbers are formatted to hours,
     * minutes and seconds. - "CURRENCY" - Numbers are formatted to
     * currency according to locale.
     */
    numberFormatType: string;
    /**
     * The number of decimal places for number. Only used for NUMERIC format type.
     */
    numDecimalPlaces: number;
    /**
     * An optional suffix for the NUMERIC format type. These strings follow the
     * same  plural rules as all Android string resources.
     */
    suffix: Schema$GamesNumberAffixConfiguration;
}
/**
 * This is a JSON template for an image configuration resource.
 */
export interface Schema$ImageConfiguration {
    /**
     * The image type for the image.
     */
    imageType: string;
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string gamesConfiguration#imageConfiguration.
     */
    kind: string;
    /**
     * The resource ID of resource which the image belongs to.
     */
    resourceId: string;
    /**
     * The url for this image.
     */
    url: string;
}
/**
 * This is a JSON template for an leaderboard configuration resource.
 */
export interface Schema$LeaderboardConfiguration {
    /**
     * The draft data of the leaderboard.
     */
    draft: Schema$LeaderboardConfigurationDetail;
    /**
     * The ID of the leaderboard.
     */
    id: string;
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string gamesConfiguration#leaderboardConfiguration.
     */
    kind: string;
    /**
     * The read-only published data of the leaderboard.
     */
    published: Schema$LeaderboardConfigurationDetail;
    /**
     * Maximum score that can be posted to this leaderboard.
     */
    scoreMax: string;
    /**
     * Minimum score that can be posted to this leaderboard.
     */
    scoreMin: string;
    /**
     * The type of the leaderboard. Possible values are:   -
     * "LARGER_IS_BETTER" - Larger scores posted are ranked higher.  -
     * "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
     */
    scoreOrder: string;
    /**
     * The token for this resource.
     */
    token: string;
}
/**
 * This is a JSON template for a leaderboard configuration detail.
 */
export interface Schema$LeaderboardConfigurationDetail {
    /**
     * The icon url of this leaderboard. Writes to this field are ignored.
     */
    iconUrl: string;
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string gamesConfiguration#leaderboardConfigurationDetail.
     */
    kind: string;
    /**
     * Localized strings for the leaderboard name.
     */
    name: Schema$LocalizedStringBundle;
    /**
     * The score formatting for the leaderboard.
     */
    scoreFormat: Schema$GamesNumberFormatConfiguration;
    /**
     * The sort rank of this leaderboard. Writes to this field are ignored.
     */
    sortRank: number;
}
/**
 * This is a JSON template for a ListConfigurations response.
 */
export interface Schema$LeaderboardConfigurationListResponse {
    /**
     * The leaderboard configurations.
     */
    items: Schema$LeaderboardConfiguration[];
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string games#leaderboardConfigurationListResponse.
     */
    kind: string;
    /**
     * The pagination token for the next page of results.
     */
    nextPageToken: string;
}
/**
 * This is a JSON template for a localized string resource.
 */
export interface Schema$LocalizedString {
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string gamesConfiguration#localizedString.
     */
    kind: string;
    /**
     * The locale string.
     */
    locale: string;
    /**
     * The string value.
     */
    value: string;
}
/**
 * This is a JSON template for a localized string bundle resource.
 */
export interface Schema$LocalizedStringBundle {
    /**
     * Uniquely identifies the type of this resource. Value is always the fixed
     * string gamesConfiguration#localizedStringBundle.
     */
    kind: string;
    /**
     * The locale strings.
     */
    translations: Schema$LocalizedString[];
}
export declare class Resource$Achievementconfigurations {
    root: Gamesconfiguration;
    constructor(root: Gamesconfiguration);
    getRoot(): Gamesconfiguration;
    /**
     * gamesConfiguration.achievementConfigurations.delete
     * @desc Delete the achievement configuration with the given ID.
     * @alias gamesConfiguration.achievementConfigurations.delete
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.achievementId The ID of the achievement used by this method.
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    delete(params?: any, options?: MethodOptions): AxiosPromise<void>;
    delete(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
    /**
     * gamesConfiguration.achievementConfigurations.get
     * @desc Retrieves the metadata of the achievement configuration with the
     * given ID.
     * @alias gamesConfiguration.achievementConfigurations.get
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.achievementId The ID of the achievement used by this method.
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    get(params?: any, options?: MethodOptions): AxiosPromise<Schema$AchievementConfiguration>;
    get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$AchievementConfiguration>, callback?: BodyResponseCallback<Schema$AchievementConfiguration>): void;
    /**
     * gamesConfiguration.achievementConfigurations.insert
     * @desc Insert a new achievement configuration in this application.
     * @alias gamesConfiguration.achievementConfigurations.insert
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.applicationId The application ID from the Google Play developer console.
     * @param {().AchievementConfiguration} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    insert(params?: any, options?: MethodOptions): AxiosPromise<Schema$AchievementConfiguration>;
    insert(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$AchievementConfiguration>, callback?: BodyResponseCallback<Schema$AchievementConfiguration>): void;
    /**
     * gamesConfiguration.achievementConfigurations.list
     * @desc Returns a list of the achievement configurations in this application.
     * @alias gamesConfiguration.achievementConfigurations.list
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.applicationId The application ID from the Google Play developer console.
     * @param {integer=} params.maxResults The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults.
     * @param {string=} params.pageToken The token returned by the previous request.
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    list(params?: any, options?: MethodOptions): AxiosPromise<Schema$AchievementConfigurationListResponse>;
    list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$AchievementConfigurationListResponse>, callback?: BodyResponseCallback<Schema$AchievementConfigurationListResponse>): void;
    /**
     * gamesConfiguration.achievementConfigurations.patch
     * @desc Update the metadata of the achievement configuration with the given
     * ID. This method supports patch semantics.
     * @alias gamesConfiguration.achievementConfigurations.patch
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.achievementId The ID of the achievement used by this method.
     * @param {().AchievementConfiguration} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    patch(params?: any, options?: MethodOptions): AxiosPromise<Schema$AchievementConfiguration>;
    patch(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$AchievementConfiguration>, callback?: BodyResponseCallback<Schema$AchievementConfiguration>): void;
    /**
     * gamesConfiguration.achievementConfigurations.update
     * @desc Update the metadata of the achievement configuration with the given
     * ID.
     * @alias gamesConfiguration.achievementConfigurations.update
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.achievementId The ID of the achievement used by this method.
     * @param {().AchievementConfiguration} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    update(params?: any, options?: MethodOptions): AxiosPromise<Schema$AchievementConfiguration>;
    update(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$AchievementConfiguration>, callback?: BodyResponseCallback<Schema$AchievementConfiguration>): void;
}
export declare class Resource$Imageconfigurations {
    root: Gamesconfiguration;
    constructor(root: Gamesconfiguration);
    getRoot(): Gamesconfiguration;
    /**
     * gamesConfiguration.imageConfigurations.upload
     * @desc Uploads an image for a resource with the given ID and image type.
     * @alias gamesConfiguration.imageConfigurations.upload
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.imageType Selects which image in a resource for this method.
     * @param {string} params.resourceId The ID of the resource used by this method.
     * @param {object} params.media Media object
     * @param {string} params.media.mimeType Media mime-type
     * @param {string|object} params.media.body Media body contents
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    upload(params?: any, options?: MethodOptions): AxiosPromise<Schema$ImageConfiguration>;
    upload(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$ImageConfiguration>, callback?: BodyResponseCallback<Schema$ImageConfiguration>): void;
}
export declare class Resource$Leaderboardconfigurations {
    root: Gamesconfiguration;
    constructor(root: Gamesconfiguration);
    getRoot(): Gamesconfiguration;
    /**
     * gamesConfiguration.leaderboardConfigurations.delete
     * @desc Delete the leaderboard configuration with the given ID.
     * @alias gamesConfiguration.leaderboardConfigurations.delete
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.leaderboardId The ID of the leaderboard.
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    delete(params?: any, options?: MethodOptions): AxiosPromise<void>;
    delete(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
    /**
     * gamesConfiguration.leaderboardConfigurations.get
     * @desc Retrieves the metadata of the leaderboard configuration with the
     * given ID.
     * @alias gamesConfiguration.leaderboardConfigurations.get
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.leaderboardId The ID of the leaderboard.
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    get(params?: any, options?: MethodOptions): AxiosPromise<Schema$LeaderboardConfiguration>;
    get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$LeaderboardConfiguration>, callback?: BodyResponseCallback<Schema$LeaderboardConfiguration>): void;
    /**
     * gamesConfiguration.leaderboardConfigurations.insert
     * @desc Insert a new leaderboard configuration in this application.
     * @alias gamesConfiguration.leaderboardConfigurations.insert
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.applicationId The application ID from the Google Play developer console.
     * @param {().LeaderboardConfiguration} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    insert(params?: any, options?: MethodOptions): AxiosPromise<Schema$LeaderboardConfiguration>;
    insert(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$LeaderboardConfiguration>, callback?: BodyResponseCallback<Schema$LeaderboardConfiguration>): void;
    /**
     * gamesConfiguration.leaderboardConfigurations.list
     * @desc Returns a list of the leaderboard configurations in this application.
     * @alias gamesConfiguration.leaderboardConfigurations.list
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.applicationId The application ID from the Google Play developer console.
     * @param {integer=} params.maxResults The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults.
     * @param {string=} params.pageToken The token returned by the previous request.
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    list(params?: any, options?: MethodOptions): AxiosPromise<Schema$LeaderboardConfigurationListResponse>;
    list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$LeaderboardConfigurationListResponse>, callback?: BodyResponseCallback<Schema$LeaderboardConfigurationListResponse>): void;
    /**
     * gamesConfiguration.leaderboardConfigurations.patch
     * @desc Update the metadata of the leaderboard configuration with the given
     * ID. This method supports patch semantics.
     * @alias gamesConfiguration.leaderboardConfigurations.patch
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.leaderboardId The ID of the leaderboard.
     * @param {().LeaderboardConfiguration} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    patch(params?: any, options?: MethodOptions): AxiosPromise<Schema$LeaderboardConfiguration>;
    patch(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$LeaderboardConfiguration>, callback?: BodyResponseCallback<Schema$LeaderboardConfiguration>): void;
    /**
     * gamesConfiguration.leaderboardConfigurations.update
     * @desc Update the metadata of the leaderboard configuration with the given
     * ID.
     * @alias gamesConfiguration.leaderboardConfigurations.update
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.leaderboardId The ID of the leaderboard.
     * @param {().LeaderboardConfiguration} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    update(params?: any, options?: MethodOptions): AxiosPromise<Schema$LeaderboardConfiguration>;
    update(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$LeaderboardConfiguration>, callback?: BodyResponseCallback<Schema$LeaderboardConfiguration>): void;
}