generated/googleapis/lib/acceleratedmobilepageurl/v1.dart

// This is a generated file (see the discoveryapis_generator project).

library googleapis.acceleratedmobilepageurl.v1;

import 'dart:core' as core;
import 'dart:async' as async;
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;

const core.String USER_AGENT = 'dart-api-client acceleratedmobilepageurl/v1';

/// Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given
/// list of public URL(s).
class AcceleratedmobilepageurlApi {
  final commons.ApiRequester _requester;

  AmpUrlsResourceApi get ampUrls => new AmpUrlsResourceApi(_requester);

  AcceleratedmobilepageurlApi(http.Client client,
      {core.String rootUrl: "https://acceleratedmobilepageurl.googleapis.com/",
      core.String servicePath: ""})
      : _requester =
            new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}

class AmpUrlsResourceApi {
  final commons.ApiRequester _requester;

  AmpUrlsResourceApi(commons.ApiRequester client) : _requester = client;

  /// Returns AMP URL(s) and equivalent
  /// [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).
  ///
  /// [request] - The metadata request object.
  ///
  /// Request parameters:
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [BatchGetAmpUrlsResponse].
  ///
  /// 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<BatchGetAmpUrlsResponse> batchGet(BatchGetAmpUrlsRequest request,
      {core.String $fields}) {
    var _url = null;
    var _queryParams = new core.Map<core.String, core.List<core.String>>();
    var _uploadMedia = null;
    var _uploadOptions = null;
    var _downloadOptions = commons.DownloadOptions.Metadata;
    var _body = null;

    if (request != null) {
      _body = convert.JSON.encode((request).toJson());
    }
    if ($fields != null) {
      _queryParams["fields"] = [$fields];
    }

    _url = 'v1/ampUrls:batchGet';

    var _response = _requester.request(_url, "POST",
        body: _body,
        queryParams: _queryParams,
        uploadOptions: _uploadOptions,
        uploadMedia: _uploadMedia,
        downloadOptions: _downloadOptions);
    return _response.then((data) => new BatchGetAmpUrlsResponse.fromJson(data));
  }
}

/// AMP URL response for a requested URL.
class AmpUrl {
  /// The AMP URL pointing to the publisher's web server.
  core.String ampUrl;

  /// The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to
  /// the cached document in the Google AMP Cache.
  core.String cdnAmpUrl;

  /// The original non-AMP URL.
  core.String originalUrl;

  AmpUrl();

  AmpUrl.fromJson(core.Map _json) {
    if (_json.containsKey("ampUrl")) {
      ampUrl = _json["ampUrl"];
    }
    if (_json.containsKey("cdnAmpUrl")) {
      cdnAmpUrl = _json["cdnAmpUrl"];
    }
    if (_json.containsKey("originalUrl")) {
      originalUrl = _json["originalUrl"];
    }
  }

  core.Map<core.String, core.Object> toJson() {
    final core.Map<core.String, core.Object> _json =
        new core.Map<core.String, core.Object>();
    if (ampUrl != null) {
      _json["ampUrl"] = ampUrl;
    }
    if (cdnAmpUrl != null) {
      _json["cdnAmpUrl"] = cdnAmpUrl;
    }
    if (originalUrl != null) {
      _json["originalUrl"] = originalUrl;
    }
    return _json;
  }
}

/// AMP URL Error resource for a requested URL that couldn't be found.
class AmpUrlError {
  /// The error code of an API call.
  /// Possible string values are:
  /// - "ERROR_CODE_UNSPECIFIED" : Not specified error.
  /// - "INPUT_URL_NOT_FOUND" : Indicates the requested URL is not found in the
  /// index, possibly because
  /// it's unable to be found, not able to be accessed by Googlebot, or some
  /// other error.
  /// - "NO_AMP_URL" : Indicates no AMP URL has been found that corresponds to
  /// the requested
  /// URL.
  /// - "APPLICATION_ERROR" : Indicates some kind of application error occurred
  /// at the server.
  /// Client advised to retry.
  /// - "URL_IS_VALID_AMP" : DEPRECATED: Indicates the requested URL is a valid
  /// AMP URL.  This is a
  /// non-error state, should not be relied upon as a sign of success or
  /// failure.  It will be removed in future versions of the API.
  /// - "URL_IS_INVALID_AMP" : Indicates that an AMP URL has been found that
  /// corresponds to the request
  /// URL, but it is not valid AMP HTML.
  core.String errorCode;

  /// An optional descriptive error message.
  core.String errorMessage;

  /// The original non-AMP URL.
  core.String originalUrl;

  AmpUrlError();

  AmpUrlError.fromJson(core.Map _json) {
    if (_json.containsKey("errorCode")) {
      errorCode = _json["errorCode"];
    }
    if (_json.containsKey("errorMessage")) {
      errorMessage = _json["errorMessage"];
    }
    if (_json.containsKey("originalUrl")) {
      originalUrl = _json["originalUrl"];
    }
  }

  core.Map<core.String, core.Object> toJson() {
    final core.Map<core.String, core.Object> _json =
        new core.Map<core.String, core.Object>();
    if (errorCode != null) {
      _json["errorCode"] = errorCode;
    }
    if (errorMessage != null) {
      _json["errorMessage"] = errorMessage;
    }
    if (originalUrl != null) {
      _json["originalUrl"] = originalUrl;
    }
    return _json;
  }
}

/// AMP URL request for a batch of URLs.
class BatchGetAmpUrlsRequest {
  /// The lookup_strategy being requested.
  /// Possible string values are:
  /// - "FETCH_LIVE_DOC" : FETCH_LIVE_DOC strategy involves live document fetch
  /// of URLs not found in
  /// the index. Any request URL not found in the index is crawled in realtime
  /// to validate if there is a corresponding AMP URL. This strategy has higher
  /// coverage but with extra latency introduced by realtime crawling. This is
  /// the default strategy. Applications using this strategy should set higher
  /// HTTP timeouts of the API calls.
  /// - "IN_INDEX_DOC" : IN_INDEX_DOC strategy skips fetching live documents of
  /// URL(s) not found
  /// in index. For applications which need low latency use of IN_INDEX_DOC
  /// strategy is recommended.
  core.String lookupStrategy;

  /// List of URLs to look up for the paired AMP URLs.
  /// The URLs are case-sensitive. Up to 50 URLs per lookup
  /// (see [Usage Limits](/amp/cache/reference/limits)).
  core.List<core.String> urls;

  BatchGetAmpUrlsRequest();

  BatchGetAmpUrlsRequest.fromJson(core.Map _json) {
    if (_json.containsKey("lookupStrategy")) {
      lookupStrategy = _json["lookupStrategy"];
    }
    if (_json.containsKey("urls")) {
      urls = _json["urls"];
    }
  }

  core.Map<core.String, core.Object> toJson() {
    final core.Map<core.String, core.Object> _json =
        new core.Map<core.String, core.Object>();
    if (lookupStrategy != null) {
      _json["lookupStrategy"] = lookupStrategy;
    }
    if (urls != null) {
      _json["urls"] = urls;
    }
    return _json;
  }
}

/// Batch AMP URL response.
class BatchGetAmpUrlsResponse {
  /// For each URL in BatchAmpUrlsRequest, the URL response. The response might
  /// not be in the same order as URLs in the batch request.
  /// If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated
  /// only once.
  core.List<AmpUrl> ampUrls;

  /// The errors for requested URLs that have no AMP URL.
  core.List<AmpUrlError> urlErrors;

  BatchGetAmpUrlsResponse();

  BatchGetAmpUrlsResponse.fromJson(core.Map _json) {
    if (_json.containsKey("ampUrls")) {
      ampUrls = _json["ampUrls"]
          .map<AmpUrl>((value) => new AmpUrl.fromJson(value))
          .toList();
    }
    if (_json.containsKey("urlErrors")) {
      urlErrors = _json["urlErrors"]
          .map<AmpUrlError>((value) => new AmpUrlError.fromJson(value))
          .toList();
    }
  }

  core.Map<core.String, core.Object> toJson() {
    final core.Map<core.String, core.Object> _json =
        new core.Map<core.String, core.Object>();
    if (ampUrls != null) {
      _json["ampUrls"] = ampUrls.map((value) => (value).toJson()).toList();
    }
    if (urlErrors != null) {
      _json["urlErrors"] = urlErrors.map((value) => (value).toJson()).toList();
    }
    return _json;
  }
}