Roll of googleapis as of 4/7/2015.

generated/googleapis/lib/pagespeedonline/v1.dart

+// This is a generated file (see the discoveryapis_generator project).
+
 library googleapis.pagespeedonline.v1;
 
-import "dart:core" as core;
-import "dart:collection" as collection;
-import "dart:async" as async;
-import "dart:convert" as convert;
+import 'dart:core' as core;
+import 'dart:collection' as collection;
+import 'dart:async' as async;
+import 'dart:convert' as convert;
 
-import "package:crypto/crypto.dart" as crypto;
+import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
+import 'package:crypto/crypto.dart' as crypto;
 import 'package:http/http.dart' as http;
-import '../src/common_internal.dart' as common_internal;
-import '../common/common.dart' as common;
 
-export '../common/common.dart' show ApiRequestError;
-export '../common/common.dart' show DetailedApiRequestError;
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
+    ApiRequestError, DetailedApiRequestError;
+
+const core.String USER_AGENT = 'dart-api-client pagespeedonline/v1';
 
 /**
  * Lets you analyze the performance of a web page and get tailored suggestions
  * to make that page faster.
  */
 class PagespeedonlineApi {
 
-  final common_internal.ApiRequester _requester;
+  final commons.ApiRequester _requester;
 
   PagespeedapiResourceApi get pagespeedapi => new PagespeedapiResourceApi(_requester);
 
   PagespeedonlineApi(http.Client client, {core.String rootUrl: "https://www.googleapis.com/", core.String servicePath: "pagespeedonline/v1/"}) :
-      _requester = new common_internal.ApiRequester(client, rootUrl, servicePath);
+      _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
 }
 
 
-/** Not documented yet. */
 class PagespeedapiResourceApi {
-  final common_internal.ApiRequester _requester;
+  final commons.ApiRequester _requester;
 
-  PagespeedapiResourceApi(common_internal.ApiRequester client) : 
+  PagespeedapiResourceApi(commons.ApiRequester client) : 
       _requester = client;
 
   /**
-   * Runs Page Speed analysis on the page at the specified URL, and returns a
-   * Page Speed score, a list of suggestions to make that page faster, and other
+   * Runs PageSpeed analysis on the page at the specified URL, and returns a
+   * PageSpeed score, a list of suggestions to make that page faster, and other
    * information.
    *
    * Request parameters:
    *
    * [url] - The URL to fetch and analyze
    * Value must have pattern "http(s)?://.*".
    *
    * [filterThirdPartyResources] - Indicates if third party resources should be
    * filtered out before PageSpeed analysis.
    *
    * [locale] - The locale used to localize formatted results
    * Value must have pattern "[a-zA-Z]+(_[a-zA-Z]+)?".
    *
-   * [rule] - A Page Speed rule to run; if none are given, all rules are run
+   * [rule] - A PageSpeed rule to run; if none are given, all rules are run
    * Value must have pattern "[a-zA-Z]+".
    *
    * [screenshot] - Indicates if binary data containing a screenshot should be
    * included
    *
    * [strategy] - The analysis strategy to use
    * Possible string values are:
    * - "desktop" : Fetch and analyze the URL for desktop browsers
    * - "mobile" : Fetch and analyze the URL for mobile devices
    *
    * Completes with a [Result].
    *
-   * Completes with a [common.ApiRequestError] if the API endpoint returned an
+   * 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<Result> runpagespeed(core.String url, {core.bool filterThirdPartyResources, core.String locale, core.List<core.String> rule, core.bool screenshot, core.String strategy}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
-    var _downloadOptions = common.DownloadOptions.Metadata;
+    var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (url == null) {
       throw new core.ArgumentError("Parameter url is required.");
     }
     _queryParams["url"] = [url];
     if (filterThirdPartyResources != null) {
       _queryParams["filter_third_party_resources"] = ["${filterThirdPartyResources}"];
     }
     if (locale != null) {
@@ skipping 19 matching lines @@
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Result.fromJson(data));
   }
 
 }
 
 
 
-/** Not documented yet. */
 class ResultFormattedResultsRuleResultsValueUrlBlocksHeaderArgs {
   /**
    * Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or
    * DURATION.
    */
   core.String type;
 
   /** Argument value, as a localized string. */
   core.String value;
 
@@ skipping 52 matching lines @@
       _json["args"] = args.map((value) => (value).toJson()).toList();
     }
     if (format != null) {
       _json["format"] = format;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
 class ResultFormattedResultsRuleResultsValueUrlBlocksUrlsDetailsArgs {
   /**
    * Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or
    * DURATION.
    */
   core.String type;
 
   /** Argument value, as a localized string. */
   core.String value;
 
@@ skipping 15 matching lines @@
       _json["type"] = type;
     }
     if (value != null) {
       _json["value"] = value;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
 class ResultFormattedResultsRuleResultsValueUrlBlocksUrlsDetails {
   /** List of arguments for the format string. */
   core.List<ResultFormattedResultsRuleResultsValueUrlBlocksUrlsDetailsArgs> args;
 
   /**
    * A localized format string with $N placeholders, where N is the 1-indexed
    * argument number, e.g. 'Unnecessary metadata for this resource adds an
    * additional $1 bytes to its download size'.
    */
   core.String format;
@@ skipping 16 matching lines @@
       _json["args"] = args.map((value) => (value).toJson()).toList();
     }
     if (format != null) {
       _json["format"] = format;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
 class ResultFormattedResultsRuleResultsValueUrlBlocksUrlsResultArgs {
   /**
    * Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or
    * DURATION.
    */
   core.String type;
 
   /** Argument value, as a localized string. */
   core.String value;
 
@@ skipping 54 matching lines @@
       _json["args"] = args.map((value) => (value).toJson()).toList();
     }
     if (format != null) {
       _json["format"] = format;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
 class ResultFormattedResultsRuleResultsValueUrlBlocksUrls {
   /**
    * List of entries that provide additional details about a single URL.
    * Optional.
    */
   core.List<ResultFormattedResultsRuleResultsValueUrlBlocksUrlsDetails> details;
 
   /**
    * A format string that gives information about the URL, and a list of
    * arguments for that format string.
@@ skipping 18 matching lines @@
       _json["details"] = details.map((value) => (value).toJson()).toList();
     }
     if (result != null) {
       _json["result"] = (result).toJson();
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
 class ResultFormattedResultsRuleResultsValueUrlBlocks {
   /** Heading to be displayed with the list of URLs. */
   ResultFormattedResultsRuleResultsValueUrlBlocksHeader header;
 
   /**
    * List of entries that provide information about URLs in the url block.
    * Optional.
    */
   core.List<ResultFormattedResultsRuleResultsValueUrlBlocksUrls> urls;
 
@@ skipping 72 matching lines @@
     }
     if (urlBlocks != null) {
       _json["urlBlocks"] = urlBlocks.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
 
 /**
- * Localized Page Speed results. Contains a ruleResults entry for each Page
- * Speed rule instantiated and run by the server.
+ * Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed
+ * rule instantiated and run by the server.
  */
 class ResultFormattedResults {
   /** The locale of the formattedResults, e.g. "en_US". */
   core.String locale;
 
   /**
-   * Dictionary of formatted rule results, with one entry for each Page Speed
+   * Dictionary of formatted rule results, with one entry for each PageSpeed
    * rule instantiated and run by the server.
    */
   core.Map<core.String, ResultFormattedResultsRuleResultsValue> ruleResults;
 
 
   ResultFormattedResults();
 
   ResultFormattedResults.fromJson(core.Map _json) {
     if (_json.containsKey("locale")) {
       locale = _json["locale"];
     }
     if (_json.containsKey("ruleResults")) {
-      ruleResults = common_internal.mapMap(_json["ruleResults"], (item) => new ResultFormattedResultsRuleResultsValue.fromJson(item));
+      ruleResults = commons.mapMap(_json["ruleResults"], (item) => new ResultFormattedResultsRuleResultsValue.fromJson(item));
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (locale != null) {
       _json["locale"] = locale;
     }
     if (ruleResults != null) {
-      _json["ruleResults"] = common_internal.mapMap(ruleResults, (item) => (item).toJson());
+      _json["ruleResults"] = commons.mapMap(ruleResults, (item) => (item).toJson());
     }
     return _json;
   }
 }
 
 
 /**
  * Summary statistics for the page, such as number of JavaScript bytes, number
  * of HTML bytes, etc.
  */
@@ skipping 127 matching lines @@
       _json["textResponseBytes"] = textResponseBytes;
     }
     if (totalRequestBytes != null) {
       _json["totalRequestBytes"] = totalRequestBytes;
     }
     return _json;
   }
 }
 
 
-/** Base64 encoded screenshot of the page that was analyzed. */
+/** Base64-encoded screenshot of the page that was analyzed. */
 class ResultScreenshot {
   /** Image data base64 encoded. */
   core.String data;
 
   core.List<core.int> get dataAsBytes {
     return crypto.CryptoUtils.base64StringToBytes(data);
   }
 
   void set dataAsBytes(core.List<core.int> _bytes) {
     data = crypto.CryptoUtils.bytesToBase64(_bytes, urlSafe: true);
@@ skipping 38 matching lines @@
       _json["mime_type"] = mimeType;
     }
     if (width != null) {
       _json["width"] = width;
     }
     return _json;
   }
 }
 
 
-/** The version of the Page Speed SDK used to generate these results. */
+/** The version of PageSpeed used to generate these results. */
 class ResultVersion {
-  /**
-   * The major version number of the Page Speed SDK used to generate these
-   * results.
-   */
+  /** The major version number of PageSpeed used to generate these results. */
   core.int major;
 
-  /**
-   * The minor version number of the Page Speed SDK used to generate these
-   * results.
-   */
+  /** The minor version number of PageSpeed used to generate these results. */
   core.int minor;
 
 
   ResultVersion();
 
   ResultVersion.fromJson(core.Map _json) {
     if (_json.containsKey("major")) {
       major = _json["major"];
     }
     if (_json.containsKey("minor")) {
       minor = _json["minor"];
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (major != null) {
       _json["major"] = major;
     }
     if (minor != null) {
       _json["minor"] = minor;
     }
     return _json;
   }
 }
 
 
-/** Not documented yet. */
 class Result {
   /**
-   * Localized Page Speed results. Contains a ruleResults entry for each Page
-   * Speed rule instantiated and run by the server.
+   * Localized PageSpeed results. Contains a ruleResults entry for each
+   * PageSpeed rule instantiated and run by the server.
    */
   ResultFormattedResults formattedResults;
 
   /**
    * Canonicalized and final URL for the document, after following page
    * redirects (if any).
    */
   core.String id;
 
   /**
@@ skipping 11 matching lines @@
    */
   ResultPageStats pageStats;
 
   /**
    * Response code for the document. 200 indicates a normal page load. 4xx/5xx
    * indicates an error.
    */
   core.int responseCode;
 
   /**
-   * The Page Speed Score (0-100), which indicates how much faster a page could
+   * The PageSpeed Score (0-100), which indicates how much faster a page could
    * be. A high score indicates little room for improvement, while a lower score
    * indicates more room for improvement.
    */
   core.int score;
 
-  /** Base64 encoded screenshot of the page that was analyzed. */
+  /** Base64-encoded screenshot of the page that was analyzed. */
   ResultScreenshot screenshot;
 
   /** Title of the page, as displayed in the browser's title bar. */
   core.String title;
 
-  /** The version of the Page Speed SDK used to generate these results. */
+  /** The version of PageSpeed used to generate these results. */
   ResultVersion version;
 
 
   Result();
 
   Result.fromJson(core.Map _json) {
     if (_json.containsKey("formattedResults")) {
       formattedResults = new ResultFormattedResults.fromJson(_json["formattedResults"]);
     }
     if (_json.containsKey("id")) {
@@ skipping 53 matching lines @@
     }
     if (title != null) {
       _json["title"] = title;
     }
     if (version != null) {
       _json["version"] = (version).toJson();
     }
     return _json;
   }
 }
-
-