Index: generated/googleapis/lib/consumersurveys/v2.dart |
diff --git a/generated/googleapis/lib/consumersurveys/v2.dart b/generated/googleapis/lib/consumersurveys/v2.dart |
index cea73a61304adb8bfaadd0d7b55da383e467d027..059565b8c84de86f92528cdb264fce30d3ccc798 100644 |
--- a/generated/googleapis/lib/consumersurveys/v2.dart |
+++ b/generated/googleapis/lib/consumersurveys/v2.dart |
@@ -9,60 +9,66 @@ import 'dart:convert' as convert; |
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
import 'package:http/http.dart' as http; |
-export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show |
- ApiRequestError, DetailedApiRequestError, Media, UploadOptions, |
- ResumableUploadOptions, DownloadOptions, PartialDownloadOptions, |
- ByteRange; |
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' |
+ show |
+ ApiRequestError, |
+ DetailedApiRequestError, |
+ Media, |
+ UploadOptions, |
+ ResumableUploadOptions, |
+ DownloadOptions, |
+ PartialDownloadOptions, |
+ ByteRange; |
const core.String USER_AGENT = 'dart-api-client consumersurveys/v2'; |
-/** |
- * Creates and conducts surveys, lists the surveys that an authenticated user |
- * owns, and retrieves survey results and information about specified surveys. |
- */ |
+/// Creates and conducts surveys, lists the surveys that an authenticated user |
+/// owns, and retrieves survey results and information about specified surveys. |
class ConsumersurveysApi { |
- /** View and edit your surveys and results */ |
- static const ConsumersurveysScope = "https://www.googleapis.com/auth/consumersurveys"; |
+ /// View and edit your surveys and results |
+ static const ConsumersurveysScope = |
+ "https://www.googleapis.com/auth/consumersurveys"; |
- /** View the results for your surveys */ |
- static const ConsumersurveysReadonlyScope = "https://www.googleapis.com/auth/consumersurveys.readonly"; |
- |
- /** View your email address */ |
- static const UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"; |
+ /// View the results for your surveys |
+ static const ConsumersurveysReadonlyScope = |
+ "https://www.googleapis.com/auth/consumersurveys.readonly"; |
+ /// View your email address |
+ static const UserinfoEmailScope = |
+ "https://www.googleapis.com/auth/userinfo.email"; |
final commons.ApiRequester _requester; |
- MobileapppanelsResourceApi get mobileapppanels => new MobileapppanelsResourceApi(_requester); |
+ MobileapppanelsResourceApi get mobileapppanels => |
+ new MobileapppanelsResourceApi(_requester); |
ResultsResourceApi get results => new ResultsResourceApi(_requester); |
SurveysResourceApi get surveys => new SurveysResourceApi(_requester); |
- ConsumersurveysApi(http.Client client, {core.String rootUrl: "https://www.googleapis.com/", core.String servicePath: "consumersurveys/v2/"}) : |
- _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT); |
+ ConsumersurveysApi(http.Client client, |
+ {core.String rootUrl: "https://www.googleapis.com/", |
+ core.String servicePath: "consumersurveys/v2/"}) |
+ : _requester = |
+ new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT); |
} |
- |
class MobileapppanelsResourceApi { |
final commons.ApiRequester _requester; |
- MobileapppanelsResourceApi(commons.ApiRequester client) : |
- _requester = client; |
- |
- /** |
- * Retrieves a MobileAppPanel that is available to the authenticated user. |
- * |
- * Request parameters: |
- * |
- * [panelId] - External URL ID for the panel. |
- * |
- * Completes with a [MobileAppPanel]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
+ MobileapppanelsResourceApi(commons.ApiRequester client) : _requester = client; |
+ |
+ /// Retrieves a MobileAppPanel that is available to the authenticated user. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [panelId] - External URL ID for the panel. |
+ /// |
+ /// Completes with a [MobileAppPanel]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
async.Future<MobileAppPanel> get(core.String panelId) { |
var _url = null; |
var _queryParams = new core.Map(); |
@@ -77,36 +83,34 @@ class MobileapppanelsResourceApi { |
_url = 'mobileAppPanels/' + commons.Escaper.ecapeVariable('$panelId'); |
- var _response = _requester.request(_url, |
- "GET", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "GET", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new MobileAppPanel.fromJson(data)); |
} |
- /** |
- * Lists the MobileAppPanels available to the authenticated user. |
- * |
- * Request parameters: |
- * |
- * [maxResults] - null |
- * |
- * [startIndex] - null |
- * |
- * [token] - null |
- * |
- * Completes with a [MobileAppPanelsListResponse]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
- async.Future<MobileAppPanelsListResponse> list({core.int maxResults, core.int startIndex, core.String token}) { |
+ /// Lists the MobileAppPanels available to the authenticated user. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [maxResults] - null |
+ /// |
+ /// [startIndex] - null |
+ /// |
+ /// [token] - null |
+ /// |
+ /// Completes with a [MobileAppPanelsListResponse]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
+ async.Future<MobileAppPanelsListResponse> list( |
+ {core.int maxResults, core.int startIndex, core.String token}) { |
var _url = null; |
var _queryParams = new core.Map(); |
var _uploadMedia = null; |
@@ -126,35 +130,34 @@ class MobileapppanelsResourceApi { |
_url = 'mobileAppPanels'; |
- var _response = _requester.request(_url, |
- "GET", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
- return _response.then((data) => new MobileAppPanelsListResponse.fromJson(data)); |
+ var _response = _requester.request(_url, "GET", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
+ return _response |
+ .then((data) => new MobileAppPanelsListResponse.fromJson(data)); |
} |
- /** |
- * Updates a MobileAppPanel. Currently the only property that can be updated |
- * is the owners property. |
- * |
- * [request] - The metadata request object. |
- * |
- * Request parameters: |
- * |
- * [panelId] - External URL ID for the panel. |
- * |
- * Completes with a [MobileAppPanel]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
- async.Future<MobileAppPanel> update(MobileAppPanel request, core.String panelId) { |
+ /// Updates a MobileAppPanel. Currently the only property that can be updated |
+ /// is the owners property. |
+ /// |
+ /// [request] - The metadata request object. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [panelId] - External URL ID for the panel. |
+ /// |
+ /// Completes with a [MobileAppPanel]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
+ async.Future<MobileAppPanel> update( |
+ MobileAppPanel request, core.String panelId) { |
var _url = null; |
var _queryParams = new core.Map(); |
var _uploadMedia = null; |
@@ -171,53 +174,49 @@ class MobileapppanelsResourceApi { |
_url = 'mobileAppPanels/' + commons.Escaper.ecapeVariable('$panelId'); |
- var _response = _requester.request(_url, |
- "PUT", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "PUT", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new MobileAppPanel.fromJson(data)); |
} |
- |
} |
- |
class ResultsResourceApi { |
final commons.ApiRequester _requester; |
- ResultsResourceApi(commons.ApiRequester client) : |
- _requester = client; |
- |
- /** |
- * 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. |
- * |
- * [request] - The metadata request object. |
- * |
- * Request parameters: |
- * |
- * [surveyUrlId] - External URL ID for the survey. |
- * |
- * [downloadOptions] - Options for downloading. A download can be either a |
- * Metadata (default) or Media download. Partial Media downloads are possible |
- * as well. |
- * |
- * Completes with a |
- * |
- * - [SurveyResults] for Metadata downloads (see [downloadOptions]). |
- * |
- * - [commons.Media] for Media downloads (see [downloadOptions]). |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
- async.Future get(ResultsGetRequest request, core.String surveyUrlId, {commons.DownloadOptions downloadOptions: commons.DownloadOptions.Metadata}) { |
+ ResultsResourceApi(commons.ApiRequester client) : _requester = client; |
+ |
+ /// 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. |
+ /// |
+ /// [request] - The metadata request object. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [surveyUrlId] - External URL ID for the survey. |
+ /// |
+ /// [downloadOptions] - Options for downloading. A download can be either a |
+ /// Metadata (default) or Media download. Partial Media downloads are |
+ /// possible as well. |
+ /// |
+ /// Completes with a |
+ /// |
+ /// - [SurveyResults] for Metadata downloads (see [downloadOptions]). |
+ /// |
+ /// - [commons.Media] for Media downloads (see [downloadOptions]). |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
+ async.Future get(ResultsGetRequest request, core.String surveyUrlId, |
+ {commons.DownloadOptions downloadOptions: |
+ commons.DownloadOptions.Metadata}) { |
var _url = null; |
var _queryParams = new core.Map(); |
var _uploadMedia = null; |
@@ -234,15 +233,15 @@ class ResultsResourceApi { |
_downloadOptions = downloadOptions; |
- _url = 'surveys/' + commons.Escaper.ecapeVariable('$surveyUrlId') + '/results'; |
+ _url = |
+ 'surveys/' + commons.Escaper.ecapeVariable('$surveyUrlId') + '/results'; |
- var _response = _requester.request(_url, |
- "GET", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "GET", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
if (_downloadOptions == null || |
_downloadOptions == commons.DownloadOptions.Metadata) { |
return _response.then((data) => new SurveyResults.fromJson(data)); |
@@ -250,31 +249,26 @@ class ResultsResourceApi { |
return _response; |
} |
} |
- |
} |
- |
class SurveysResourceApi { |
final commons.ApiRequester _requester; |
- SurveysResourceApi(commons.ApiRequester client) : |
- _requester = client; |
- |
- /** |
- * Removes a survey from view in all user GET requests. |
- * |
- * Request parameters: |
- * |
- * [surveyUrlId] - External URL ID for the survey. |
- * |
- * Completes with a [SurveysDeleteResponse]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
+ SurveysResourceApi(commons.ApiRequester client) : _requester = client; |
+ |
+ /// Removes a survey from view in all user GET requests. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [surveyUrlId] - External URL ID for the survey. |
+ /// |
+ /// Completes with a [SurveysDeleteResponse]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
async.Future<SurveysDeleteResponse> delete(core.String surveyUrlId) { |
var _url = null; |
var _queryParams = new core.Map(); |
@@ -289,31 +283,28 @@ class SurveysResourceApi { |
_url = 'surveys/' + commons.Escaper.ecapeVariable('$surveyUrlId'); |
- var _response = _requester.request(_url, |
- "DELETE", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "DELETE", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new SurveysDeleteResponse.fromJson(data)); |
} |
- /** |
- * Retrieves information about the specified survey. |
- * |
- * Request parameters: |
- * |
- * [surveyUrlId] - External URL ID for the survey. |
- * |
- * Completes with a [Survey]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
+ /// Retrieves information about the specified survey. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [surveyUrlId] - External URL ID for the survey. |
+ /// |
+ /// Completes with a [Survey]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
async.Future<Survey> get(core.String surveyUrlId) { |
var _url = null; |
var _queryParams = new core.Map(); |
@@ -328,31 +319,28 @@ class SurveysResourceApi { |
_url = 'surveys/' + commons.Escaper.ecapeVariable('$surveyUrlId'); |
- var _response = _requester.request(_url, |
- "GET", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "GET", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new Survey.fromJson(data)); |
} |
- /** |
- * Creates a survey. |
- * |
- * [request] - The metadata request object. |
- * |
- * Request parameters: |
- * |
- * Completes with a [Survey]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
+ /// Creates a survey. |
+ /// |
+ /// [request] - The metadata request object. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// Completes with a [Survey]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
async.Future<Survey> insert(Survey request) { |
var _url = null; |
var _queryParams = new core.Map(); |
@@ -367,36 +355,34 @@ class SurveysResourceApi { |
_url = 'surveys'; |
- var _response = _requester.request(_url, |
- "POST", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "POST", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new Survey.fromJson(data)); |
} |
- /** |
- * Lists the surveys owned by the authenticated user. |
- * |
- * Request parameters: |
- * |
- * [maxResults] - null |
- * |
- * [startIndex] - null |
- * |
- * [token] - null |
- * |
- * Completes with a [SurveysListResponse]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
- async.Future<SurveysListResponse> list({core.int maxResults, core.int startIndex, core.String token}) { |
+ /// Lists the surveys owned by the authenticated user. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [maxResults] - null |
+ /// |
+ /// [startIndex] - null |
+ /// |
+ /// [token] - null |
+ /// |
+ /// Completes with a [SurveysListResponse]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
+ async.Future<SurveysListResponse> list( |
+ {core.int maxResults, core.int startIndex, core.String token}) { |
var _url = null; |
var _queryParams = new core.Map(); |
var _uploadMedia = null; |
@@ -416,34 +402,32 @@ class SurveysResourceApi { |
_url = 'surveys'; |
- var _response = _requester.request(_url, |
- "GET", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "GET", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new SurveysListResponse.fromJson(data)); |
} |
- /** |
- * Begins running a survey. |
- * |
- * [request] - The metadata request object. |
- * |
- * Request parameters: |
- * |
- * [resourceId] - null |
- * |
- * Completes with a [SurveysStartResponse]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
- async.Future<SurveysStartResponse> start(SurveysStartRequest request, core.String resourceId) { |
+ /// Begins running a survey. |
+ /// |
+ /// [request] - The metadata request object. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [resourceId] - null |
+ /// |
+ /// Completes with a [SurveysStartResponse]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
+ async.Future<SurveysStartResponse> start( |
+ SurveysStartRequest request, core.String resourceId) { |
var _url = null; |
var _queryParams = new core.Map(); |
var _uploadMedia = null; |
@@ -460,31 +444,28 @@ class SurveysResourceApi { |
_url = 'surveys/' + commons.Escaper.ecapeVariable('$resourceId') + '/start'; |
- var _response = _requester.request(_url, |
- "POST", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "POST", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new SurveysStartResponse.fromJson(data)); |
} |
- /** |
- * Stops a running survey. |
- * |
- * Request parameters: |
- * |
- * [resourceId] - null |
- * |
- * Completes with a [SurveysStopResponse]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
+ /// Stops a running survey. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [resourceId] - null |
+ /// |
+ /// Completes with a [SurveysStopResponse]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
async.Future<SurveysStopResponse> stop(core.String resourceId) { |
var _url = null; |
var _queryParams = new core.Map(); |
@@ -499,34 +480,31 @@ class SurveysResourceApi { |
_url = 'surveys/' + commons.Escaper.ecapeVariable('$resourceId') + '/stop'; |
- var _response = _requester.request(_url, |
- "POST", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "POST", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new SurveysStopResponse.fromJson(data)); |
} |
- /** |
- * Updates a survey. Currently the only property that can be updated is the |
- * owners property. |
- * |
- * [request] - The metadata request object. |
- * |
- * Request parameters: |
- * |
- * [surveyUrlId] - External URL ID for the survey. |
- * |
- * Completes with a [Survey]. |
- * |
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
- * error. |
- * |
- * If the used [http.Client] completes with an error when making a REST call, |
- * this method will complete with the same error. |
- */ |
+ /// Updates a survey. Currently the only property that can be updated is the |
+ /// owners property. |
+ /// |
+ /// [request] - The metadata request object. |
+ /// |
+ /// Request parameters: |
+ /// |
+ /// [surveyUrlId] - External URL ID for the survey. |
+ /// |
+ /// Completes with a [Survey]. |
+ /// |
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned |
+ /// an error. |
+ /// |
+ /// If the used [http.Client] completes with an error when making a REST |
+ /// call, this method will complete with the same error. |
async.Future<Survey> update(Survey request, core.String surveyUrlId) { |
var _url = null; |
var _queryParams = new core.Map(); |
@@ -544,20 +522,16 @@ class SurveysResourceApi { |
_url = 'surveys/' + commons.Escaper.ecapeVariable('$surveyUrlId'); |
- var _response = _requester.request(_url, |
- "PUT", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
+ var _response = _requester.request(_url, "PUT", |
+ body: _body, |
+ queryParams: _queryParams, |
+ uploadOptions: _uploadOptions, |
+ uploadMedia: _uploadMedia, |
+ downloadOptions: _downloadOptions); |
return _response.then((data) => new Survey.fromJson(data)); |
} |
- |
} |
- |
- |
class FieldMask { |
core.List<FieldMask> fields; |
core.int id; |
@@ -566,7 +540,9 @@ class FieldMask { |
FieldMask.fromJson(core.Map _json) { |
if (_json.containsKey("fields")) { |
- fields = _json["fields"].map((value) => new FieldMask.fromJson(value)).toList(); |
+ fields = _json["fields"] |
+ .map((value) => new FieldMask.fromJson(value)) |
+ .toList(); |
} |
if (_json.containsKey("id")) { |
id = _json["id"]; |
@@ -574,7 +550,8 @@ class FieldMask { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (fields != null) { |
_json["fields"] = fields.map((value) => (value).toJson()).toList(); |
} |
@@ -617,7 +594,8 @@ class MobileAppPanel { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (country != null) { |
_json["country"] = country; |
} |
@@ -642,12 +620,12 @@ class MobileAppPanel { |
class MobileAppPanelsListResponse { |
PageInfo pageInfo; |
- /** |
- * Unique request ID used for logging and debugging. Please include in any |
- * error reporting or troubleshooting requests. |
- */ |
+ |
+ /// Unique request ID used for logging and debugging. Please include in any |
+ /// error reporting or troubleshooting requests. |
core.String requestId; |
- /** An individual predefined panel of Opinion Rewards mobile users. */ |
+ |
+ /// An individual predefined panel of Opinion Rewards mobile users. |
core.List<MobileAppPanel> resources; |
TokenPagination tokenPagination; |
@@ -661,7 +639,9 @@ class MobileAppPanelsListResponse { |
requestId = _json["requestId"]; |
} |
if (_json.containsKey("resources")) { |
- resources = _json["resources"].map((value) => new MobileAppPanel.fromJson(value)).toList(); |
+ resources = _json["resources"] |
+ .map((value) => new MobileAppPanel.fromJson(value)) |
+ .toList(); |
} |
if (_json.containsKey("tokenPagination")) { |
tokenPagination = new TokenPagination.fromJson(_json["tokenPagination"]); |
@@ -669,7 +649,8 @@ class MobileAppPanelsListResponse { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (pageInfo != null) { |
_json["pageInfo"] = (pageInfo).toJson(); |
} |
@@ -706,7 +687,8 @@ class PageInfo { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (resultPerPage != null) { |
_json["resultPerPage"] = resultPerPage; |
} |
@@ -732,7 +714,8 @@ class ResultsGetRequest { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (resultMask != null) { |
_json["resultMask"] = (resultMask).toJson(); |
} |
@@ -748,7 +731,9 @@ class ResultsMask { |
ResultsMask.fromJson(core.Map _json) { |
if (_json.containsKey("fields")) { |
- fields = _json["fields"].map((value) => new FieldMask.fromJson(value)).toList(); |
+ fields = _json["fields"] |
+ .map((value) => new FieldMask.fromJson(value)) |
+ .toList(); |
} |
if (_json.containsKey("projection")) { |
projection = _json["projection"]; |
@@ -756,7 +741,8 @@ class ResultsMask { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (fields != null) { |
_json["fields"] = fields.map((value) => (value).toJson()).toList(); |
} |
@@ -776,8 +762,10 @@ class Survey { |
} |
void set customerDataAsBytes(core.List<core.int> _bytes) { |
- customerData = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-"); |
+ customerData = |
+ convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-"); |
} |
+ |
core.String description; |
core.List<core.String> owners; |
core.List<SurveyQuestion> questions; |
@@ -806,7 +794,9 @@ class Survey { |
owners = _json["owners"]; |
} |
if (_json.containsKey("questions")) { |
- questions = _json["questions"].map((value) => new SurveyQuestion.fromJson(value)).toList(); |
+ questions = _json["questions"] |
+ .map((value) => new SurveyQuestion.fromJson(value)) |
+ .toList(); |
} |
if (_json.containsKey("rejectionReason")) { |
rejectionReason = new SurveyRejection.fromJson(_json["rejectionReason"]); |
@@ -826,7 +816,8 @@ class Survey { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (audience != null) { |
_json["audience"] = (audience).toJson(); |
} |
@@ -900,7 +891,8 @@ class SurveyAudience { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (ages != null) { |
_json["ages"] = ages; |
} |
@@ -950,7 +942,8 @@ class SurveyCost { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (costPerResponseNanos != null) { |
_json["costPerResponseNanos"] = costPerResponseNanos; |
} |
@@ -1003,7 +996,9 @@ class SurveyQuestion { |
highValueLabel = _json["highValueLabel"]; |
} |
if (_json.containsKey("images")) { |
- images = _json["images"].map((value) => new SurveyQuestionImage.fromJson(value)).toList(); |
+ images = _json["images"] |
+ .map((value) => new SurveyQuestionImage.fromJson(value)) |
+ .toList(); |
} |
if (_json.containsKey("lastAnswerPositionPinned")) { |
lastAnswerPositionPinned = _json["lastAnswerPositionPinned"]; |
@@ -1047,7 +1042,8 @@ class SurveyQuestion { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (answerOrder != null) { |
_json["answerOrder"] = answerOrder; |
} |
@@ -1114,8 +1110,10 @@ class SurveyQuestionImage { |
} |
void set dataAsBytes(core.List<core.int> _bytes) { |
- data = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-"); |
+ data = |
+ convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-"); |
} |
+ |
core.String url; |
SurveyQuestionImage(); |
@@ -1133,7 +1131,8 @@ class SurveyQuestionImage { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (altText != null) { |
_json["altText"] = altText; |
} |
@@ -1163,7 +1162,8 @@ class SurveyRejection { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (explanation != null) { |
_json["explanation"] = explanation; |
} |
@@ -1190,7 +1190,8 @@ class SurveyResults { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (status != null) { |
_json["status"] = status; |
} |
@@ -1202,10 +1203,8 @@ class SurveyResults { |
} |
class SurveysDeleteResponse { |
- /** |
- * Unique request ID used for logging and debugging. Please include in any |
- * error reporting or troubleshooting requests. |
- */ |
+ /// Unique request ID used for logging and debugging. Please include in any |
+ /// error reporting or troubleshooting requests. |
core.String requestId; |
SurveysDeleteResponse(); |
@@ -1217,7 +1216,8 @@ class SurveysDeleteResponse { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (requestId != null) { |
_json["requestId"] = requestId; |
} |
@@ -1227,12 +1227,12 @@ class SurveysDeleteResponse { |
class SurveysListResponse { |
PageInfo pageInfo; |
- /** |
- * Unique request ID used for logging and debugging. Please include in any |
- * error reporting or troubleshooting requests. |
- */ |
+ |
+ /// Unique request ID used for logging and debugging. Please include in any |
+ /// error reporting or troubleshooting requests. |
core.String requestId; |
- /** An individual survey resource. */ |
+ |
+ /// An individual survey resource. |
core.List<Survey> resources; |
TokenPagination tokenPagination; |
@@ -1246,7 +1246,9 @@ class SurveysListResponse { |
requestId = _json["requestId"]; |
} |
if (_json.containsKey("resources")) { |
- resources = _json["resources"].map((value) => new Survey.fromJson(value)).toList(); |
+ resources = _json["resources"] |
+ .map((value) => new Survey.fromJson(value)) |
+ .toList(); |
} |
if (_json.containsKey("tokenPagination")) { |
tokenPagination = new TokenPagination.fromJson(_json["tokenPagination"]); |
@@ -1254,7 +1256,8 @@ class SurveysListResponse { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (pageInfo != null) { |
_json["pageInfo"] = (pageInfo).toJson(); |
} |
@@ -1272,10 +1275,8 @@ class SurveysListResponse { |
} |
class 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. |
- */ |
+ /// Threshold to start a survey automically if the quoted prices is less than |
+ /// or equal to this value. See Survey.Cost for more details. |
core.String maxCostPerResponseNanos; |
SurveysStartRequest(); |
@@ -1287,7 +1288,8 @@ class SurveysStartRequest { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (maxCostPerResponseNanos != null) { |
_json["maxCostPerResponseNanos"] = maxCostPerResponseNanos; |
} |
@@ -1296,10 +1298,8 @@ class SurveysStartRequest { |
} |
class SurveysStartResponse { |
- /** |
- * Unique request ID used for logging and debugging. Please include in any |
- * error reporting or troubleshooting requests. |
- */ |
+ /// Unique request ID used for logging and debugging. Please include in any |
+ /// error reporting or troubleshooting requests. |
core.String requestId; |
SurveysStartResponse(); |
@@ -1311,7 +1311,8 @@ class SurveysStartResponse { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (requestId != null) { |
_json["requestId"] = requestId; |
} |
@@ -1320,10 +1321,8 @@ class SurveysStartResponse { |
} |
class SurveysStopResponse { |
- /** |
- * Unique request ID used for logging and debugging. Please include in any |
- * error reporting or troubleshooting requests. |
- */ |
+ /// Unique request ID used for logging and debugging. Please include in any |
+ /// error reporting or troubleshooting requests. |
core.String requestId; |
SurveysStopResponse(); |
@@ -1335,7 +1334,8 @@ class SurveysStopResponse { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (requestId != null) { |
_json["requestId"] = requestId; |
} |
@@ -1359,7 +1359,8 @@ class TokenPagination { |
} |
core.Map<core.String, core.Object> toJson() { |
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>(); |
+ final core.Map<core.String, core.Object> _json = |
+ new core.Map<core.String, core.Object>(); |
if (nextPageToken != null) { |
_json["nextPageToken"] = nextPageToken; |
} |