mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-29 19:10:37 +00:00
Alexey Bolisov
4f8a3d571b
* Add Google APIs typings * [gapi.cliebt.* ] Add version as part of typings name and fix gapi.client tslint errors * versions should not get their own folders fixing a few typos using /** syntax so comments show up in editors export only actual (last) version for now * export only actual (last) version for now * merge namespaces and remove unnecessary namespace qualifiers * remove namespace qualifier for gapi.client.Request from nested namespaces and change Request base interface to Promise * disable await-promise rule * fix collision between gapi.client.Request and Request from nested namespace disable no-irregular-whitespace rule * sort properties and namespace resources * remove empty comments sort resources amd methods in tests and readme.md * update 'this is autogenerated file' banner to remove this text from gapi.client namespace hint use multiline comments when comment has several lines * implement no-trailing-whitespace, no-padding, max-line-length, await-promise, no-irregular-whitespace rules * add strictFunctionTypes to tsconfig * fix "Whitespace within parentheses is not allowed" rule * fix ts-lint rules * fixes * remove deprecated replicapool and replicapoolupdater api * fix no-irregular-whitespace * fix no-irregular-whitespace
398 lines
20 KiB
TypeScript
398 lines
20 KiB
TypeScript
// Type definitions for Google Consumer Surveys API v2 2.0
|
|
// Project: undefined
|
|
// Definitions by: Bolisov Alexey <https://github.com/Bolisov>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
// IMPORTANT
|
|
// This file was generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually.
|
|
// In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator
|
|
// Generated from: https://www.googleapis.com/discovery/v1/apis/consumersurveys/v2/rest
|
|
|
|
/// <reference types="gapi.client" />
|
|
|
|
declare namespace gapi.client {
|
|
/** Load Consumer Surveys API v2 */
|
|
function load(name: "consumersurveys", version: "v2"): PromiseLike<void>;
|
|
function load(name: "consumersurveys", version: "v2", callback: () => any): void;
|
|
|
|
const mobileapppanels: consumersurveys.MobileapppanelsResource;
|
|
|
|
const results: consumersurveys.ResultsResource;
|
|
|
|
const surveys: consumersurveys.SurveysResource;
|
|
|
|
namespace consumersurveys {
|
|
interface FieldMask {
|
|
fields?: FieldMask[];
|
|
id?: number;
|
|
}
|
|
interface MobileAppPanel {
|
|
country?: string;
|
|
isPublicPanel?: boolean;
|
|
language?: string;
|
|
mobileAppPanelId?: string;
|
|
name?: string;
|
|
owners?: string[];
|
|
}
|
|
interface MobileAppPanelsListResponse {
|
|
pageInfo?: PageInfo;
|
|
/** Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */
|
|
requestId?: string;
|
|
/** An individual predefined panel of Opinion Rewards mobile users. */
|
|
resources?: MobileAppPanel[];
|
|
tokenPagination?: TokenPagination;
|
|
}
|
|
interface PageInfo {
|
|
resultPerPage?: number;
|
|
startIndex?: number;
|
|
totalResults?: number;
|
|
}
|
|
interface ResultsGetRequest {
|
|
resultMask?: ResultsMask;
|
|
}
|
|
interface ResultsMask {
|
|
fields?: FieldMask[];
|
|
projection?: string;
|
|
}
|
|
interface Survey {
|
|
audience?: SurveyAudience;
|
|
cost?: SurveyCost;
|
|
customerData?: string;
|
|
description?: string;
|
|
owners?: string[];
|
|
questions?: SurveyQuestion[];
|
|
rejectionReason?: SurveyRejection;
|
|
state?: string;
|
|
surveyUrlId?: string;
|
|
title?: string;
|
|
wantedResponseCount?: number;
|
|
}
|
|
interface SurveyAudience {
|
|
ages?: string[];
|
|
country?: string;
|
|
countrySubdivision?: string;
|
|
gender?: string;
|
|
languages?: string[];
|
|
mobileAppPanelId?: string;
|
|
populationSource?: string;
|
|
}
|
|
interface SurveyCost {
|
|
costPerResponseNanos?: string;
|
|
currencyCode?: string;
|
|
maxCostPerResponseNanos?: string;
|
|
nanos?: string;
|
|
}
|
|
interface SurveyQuestion {
|
|
answerOrder?: string;
|
|
answers?: string[];
|
|
hasOther?: boolean;
|
|
highValueLabel?: string;
|
|
images?: SurveyQuestionImage[];
|
|
lastAnswerPositionPinned?: boolean;
|
|
lowValueLabel?: string;
|
|
mustPickSuggestion?: boolean;
|
|
numStars?: string;
|
|
openTextPlaceholder?: string;
|
|
openTextSuggestions?: string[];
|
|
question?: string;
|
|
sentimentText?: string;
|
|
singleLineResponse?: boolean;
|
|
thresholdAnswers?: string[];
|
|
type?: string;
|
|
unitOfMeasurementLabel?: string;
|
|
videoId?: string;
|
|
}
|
|
interface SurveyQuestionImage {
|
|
altText?: string;
|
|
data?: string;
|
|
url?: string;
|
|
}
|
|
interface SurveyRejection {
|
|
explanation?: string;
|
|
type?: string;
|
|
}
|
|
interface SurveyResults {
|
|
status?: string;
|
|
surveyUrlId?: string;
|
|
}
|
|
interface SurveysDeleteResponse {
|
|
/** Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */
|
|
requestId?: string;
|
|
}
|
|
interface SurveysListResponse {
|
|
pageInfo?: PageInfo;
|
|
/** Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */
|
|
requestId?: string;
|
|
/** An individual survey resource. */
|
|
resources?: Survey[];
|
|
tokenPagination?: TokenPagination;
|
|
}
|
|
interface SurveysStartRequest {
|
|
/** Threshold to start a survey automically if the quoted prices is less than or equal to this value. See Survey.Cost for more details. */
|
|
maxCostPerResponseNanos?: string;
|
|
}
|
|
interface SurveysStartResponse {
|
|
/** Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */
|
|
requestId?: string;
|
|
}
|
|
interface SurveysStopResponse {
|
|
/** Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */
|
|
requestId?: string;
|
|
}
|
|
interface TokenPagination {
|
|
nextPageToken?: string;
|
|
previousPageToken?: string;
|
|
}
|
|
interface MobileapppanelsResource {
|
|
/** Retrieves a MobileAppPanel that is available to the authenticated user. */
|
|
get(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** External URL ID for the panel. */
|
|
panelId: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<MobileAppPanel>;
|
|
/** Lists the MobileAppPanels available to the authenticated user. */
|
|
list(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
maxResults?: number;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
startIndex?: number;
|
|
token?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<MobileAppPanelsListResponse>;
|
|
/** Updates a MobileAppPanel. Currently the only property that can be updated is the owners property. */
|
|
update(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** External URL ID for the panel. */
|
|
panelId: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<MobileAppPanel>;
|
|
}
|
|
interface ResultsResource {
|
|
/**
|
|
* Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an
|
|
* argument to get results.
|
|
*/
|
|
get(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** External URL ID for the survey. */
|
|
surveyUrlId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<SurveyResults>;
|
|
}
|
|
interface SurveysResource {
|
|
/** Removes a survey from view in all user GET requests. */
|
|
delete(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** External URL ID for the survey. */
|
|
surveyUrlId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<SurveysDeleteResponse>;
|
|
/** Retrieves information about the specified survey. */
|
|
get(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** External URL ID for the survey. */
|
|
surveyUrlId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Survey>;
|
|
/** Creates a survey. */
|
|
insert(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Survey>;
|
|
/** Lists the surveys owned by the authenticated user. */
|
|
list(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
maxResults?: number;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
startIndex?: number;
|
|
token?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<SurveysListResponse>;
|
|
/** Begins running a survey. */
|
|
start(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
resourceId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<SurveysStartResponse>;
|
|
/** Stops a running survey. */
|
|
stop(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
resourceId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<SurveysStopResponse>;
|
|
/** Updates a survey. Currently the only property that can be updated is the owners property. */
|
|
update(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** External URL ID for the survey. */
|
|
surveyUrlId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Survey>;
|
|
}
|
|
}
|
|
}
|