Api-roll 21: 2015-08-04

generated/googleapis/lib/androidenterprise/v1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.androidenterprise.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;
@@ skipping 1919 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => null);
   }
 
   /**
-   * Generates a URL that can be used to display an iframe to view the product's
-   * permissions (if any) and approve the product. This URL can be used to
-   * approve the product for a limited time (currently 1 hour) using the
-   * Products.approve call.
+   * Generates a URL that can be rendered in an iframe to display the
+   * permissions (if any) of a product. An enterprise admin must view these
+   * permissions and accept them on behalf of their organization in order to
+   * approve that product.
+   *
+   * Admins should accept the displayed permissions by interacting with a
+   * separate UI element in the EMM console, which in turn should trigger the
+   * use of this URL as the approvalUrlInfo.approvalUrl property in a
+   * Products.approve call to approve the product. This URL can only be used to
+   * display permissions for up to 1 day.
    *
    * Request parameters:
    *
    * [enterpriseId] - The ID of the enterprise.
    *
    * [productId] - The ID of the product.
    *
-   * [languageCode] - The language code that will be used for permission names
-   * and descriptions in the returned iframe.
+   * [languageCode] - The BCP 47 language code used for permission names and
+   * descriptions in the returned iframe, for instance "en-US".
    *
    * Completes with a [ProductsGenerateApprovalUrlResponse].
    *
    * 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<ProductsGenerateApprovalUrlResponse> generateApprovalUrl(core.String enterpriseId, core.String productId, {core.String languageCode}) {
@@ skipping 315 matching lines @@
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new User.fromJson(data));
   }
 
   /**
+   * Retrieves the set of products a user is entitled to access.
+   *
+   * Request parameters:
+   *
+   * [enterpriseId] - The ID of the enterprise.
+   *
+   * [userId] - The ID of the user.
+   *
+   * Completes with a [ProductSet].
+   *
+   * 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<ProductSet> getAvailableProductSet(core.String enterpriseId, core.String userId) {
+    var _url = null;
+    var _queryParams = new core.Map();
+    var _uploadMedia = null;
+    var _uploadOptions = null;
+    var _downloadOptions = commons.DownloadOptions.Metadata;
+    var _body = null;
+
+    if (enterpriseId == null) {
+      throw new core.ArgumentError("Parameter enterpriseId is required.");
+    }
+    if (userId == null) {
+      throw new core.ArgumentError("Parameter userId is required.");
+    }
+
+    _url = 'enterprises/' + commons.Escaper.ecapeVariable('$enterpriseId') + '/users/' + commons.Escaper.ecapeVariable('$userId') + '/availableProductSet';
+
+    var _response = _requester.request(_url,
+                                       "GET",
+                                       body: _body,
+                                       queryParams: _queryParams,
+                                       uploadOptions: _uploadOptions,
+                                       uploadMedia: _uploadMedia,
+                                       downloadOptions: _downloadOptions);
+    return _response.then((data) => new ProductSet.fromJson(data));
+  }
+
+  /**
    * Looks up a user by email address.
    *
    * Request parameters:
    *
    * [enterpriseId] - The ID of the enterprise.
    *
    * [email] - The exact primary email address of the user to look up.
    *
    * Completes with a [UsersListResponse].
    *
@@ skipping 68 matching lines @@
     var _response = _requester.request(_url,
                                        "DELETE",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => null);
   }
 
+  /**
+   * Modifies the set of products a user is entitled to access.
+   *
+   * [request] - The metadata request object.
+   *
+   * Request parameters:
+   *
+   * [enterpriseId] - The ID of the enterprise.
+   *
+   * [userId] - The ID of the user.
+   *
+   * Completes with a [ProductSet].
+   *
+   * 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<ProductSet> setAvailableProductSet(ProductSet request, core.String enterpriseId, core.String userId) {
+    var _url = null;
+    var _queryParams = new core.Map();
+    var _uploadMedia = null;
+    var _uploadOptions = null;
+    var _downloadOptions = commons.DownloadOptions.Metadata;
+    var _body = null;
+
+    if (request != null) {
+      _body = convert.JSON.encode((request).toJson());
+    }
+    if (enterpriseId == null) {
+      throw new core.ArgumentError("Parameter enterpriseId is required.");
+    }
+    if (userId == null) {
+      throw new core.ArgumentError("Parameter userId is required.");
+    }
+
+    _url = 'enterprises/' + commons.Escaper.ecapeVariable('$enterpriseId') + '/users/' + commons.Escaper.ecapeVariable('$userId') + '/availableProductSet';
+
+    var _response = _requester.request(_url,
+                                       "PUT",
+                                       body: _body,
+                                       queryParams: _queryParams,
+                                       uploadOptions: _uploadOptions,
+                                       uploadMedia: _uploadMedia,
+                                       downloadOptions: _downloadOptions);
+    return _response.then((data) => new ProductSet.fromJson(data));
+  }
+
 }
 
 
 
 /**
  * Represents the list of app restrictions available to be pre-configured for
  * the product.
  */
 class AppRestrictionsSchema {
+  /**
+   * Identifies what kind of resource this is. Value: the fixed string
+   * "androidenterprise#appRestrictionsSchema".
+   */
+  core.String kind;
   /** The set of restrictions that make up this schema. */
   core.List<AppRestrictionsSchemaRestriction> restrictions;
 
   AppRestrictionsSchema();
 
   AppRestrictionsSchema.fromJson(core.Map _json) {
+    if (_json.containsKey("kind")) {
+      kind = _json["kind"];
+    }
     if (_json.containsKey("restrictions")) {
       restrictions = _json["restrictions"].map((value) => new AppRestrictionsSchemaRestriction.fromJson(value)).toList();
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
+    if (kind != null) {
+      _json["kind"] = kind;
+    }
     if (restrictions != null) {
       _json["restrictions"] = restrictions.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
 /**
  * A restriction in the App Restriction Schema represents a piece of
  * configuration that may be pre-applied.
@@ skipping 132 matching lines @@
     if (valueMultiselect != null) {
       _json["valueMultiselect"] = valueMultiselect;
     }
     if (valueString != null) {
       _json["valueString"] = valueString;
     }
     return _json;
   }
 }
 
-/** App version represents a single APK version. */
+/** This represents a single version of the app. */
 class AppVersion {
-  /** Unique increasing identifier for the apk version. */
+  /** Unique increasing identifier for the app version. */
   core.int versionCode;
   /**
-   * The string used in the Play Store by the app developer to identify a
-   * version of an app. The string is not necessarily unique or localized (e.g.
-   * "1.4").
+   * The string used in the Play Store by the app developer to identify the
+   * version. The string is not necessarily unique or localized (for example,
+   * the string could be "1.4").
    */
   core.String versionString;
 
   AppVersion();
 
   AppVersion.fromJson(core.Map _json) {
     if (_json.containsKey("versionCode")) {
       versionCode = _json["versionCode"];
     }
     if (_json.containsKey("versionString")) {
@@ skipping 76 matching lines @@
    * "Accounting apps".
    */
   core.String name;
   /**
    * The IDs of the products in the collection, in the order in which they
    * should be displayed.
    */
   core.List<core.String> productId;
   /**
    * Whether this collection is visible to all users, or only to the users that
-   * have been granted access through the collection_viewers api. Even if a
-   * collection is visible to allUsers, it is possible to add and remove
-   * viewers, but this will have no effect until the collection's visibility
-   * changes to viewersOnly.
+   * have been granted access through the "Collectionviewers" API. With the
+   * launch of the "setAvailableProductSet" API, this property should always be
+   * set to "viewersOnly", as the "allUsers" option will bypass the
+   * "availableProductSet" for all users within a domain.
+   *
+   * The "allUsers" setting is deprecated, and will be removed.
    */
   core.String visibility;
 
   Collection();
 
   Collection.fromJson(core.Map _json) {
     if (_json.containsKey("collectionId")) {
       collectionId = _json["collectionId"];
     }
     if (_json.containsKey("kind")) {
@@ skipping 491 matching lines @@
   }
 }
 
 /**
  * A group license object indicates a product that an enterprise admin has
  * approved for use in the enterprise. The product may be free or paid. For free
  * products, a group license object is created in these cases: if the enterprise
  * admin approves a product in Google Play, if the product is added to a
  * collection, or if an entitlement for the product is created for a user via
  * the API. For paid products, a group license object is only created as part of
- * the first bulk purchase of that product in Google Play done by the enterprise
+ * the first bulk purchase of that product in Google Play by the enterprise
  * admin.
  *
  * The API can be used to query group licenses; the available information
  * includes the total number of licenses purchased (for paid products) and the
- * total number of licenses that have been provisioned, i.e. the total number of
- * user entitlements in existence for the product.
+ * total number of licenses that have been provisioned, that is, the total
+ * number of user entitlements in existence for the product.
  *
- * Group license objects are never deleted; if e.g. a free app is added to a
- * collection and then removed, the group license will remain, allowing to keep
- * track of any remaining entitlements. An enterprise admin may indicate they
- * are no longer interested in the group license by marking it as unapproved in
- * Google Play.
+ * Group license objects are never deleted. If, for example, a free app is added
+ * to a collection and then removed, the group license will remain, allowing the
+ * enterprise admin to keep track of any remaining entitlements. An enterprise
+ * admin may indicate they are no longer interested in the group license by
+ * marking it as unapproved in Google Play.
  */
 class GroupLicense {
   /**
    * How this group license was acquired. "bulkPurchase" means that this group
    * license object was created because the enterprise purchased licenses for
    * this product; this is "free" otherwise (for free products).
    */
   core.String acquisitionKind;
   /**
    * Whether the product to which this group license relates is currently
@@ skipping 326 matching lines @@
  * least some users in the enterprise. (Some apps are restricted to a single
  * enterprise, and no information about them is made available outside that
  * enterprise.)
  *
  * The information provided for each product (localized name, icon, link to the
  * full Google Play details page) is intended to allow a basic representation of
  * the product within an MDM user interface.
  */
 class Product {
   /**
-   * List of app versions available for this product. The returned list contains
-   * only public versions. E.g. alpha, beta or canary versions will not be
-   * included.
+   * App versions currently available for this product. The returned list
+   * contains only public versions. Alpha and beta versions are not included.
    */
   core.List<AppVersion> appVersion;
   /** The name of the author of the product (e.g. the app developer). */
   core.String authorName;
   /** A link to the (consumer) Google Play details page for the product. */
   core.String detailsUrl;
-  /** How and to whom the package is made available. */
+  /**
+   * How and to whom the package is made available. The value publicGoogleHosted
+   * means that the package is available through the Play Store and not
+   * restricted to a specific enterprise. The value privateGoogleHosted means
+   * that the package is a private app (restricted to an enterprise) but hosted
+   * by Google. The value privateSelfHosted means that the package is a private
+   * app (restricted to an enterprise) and is privately hosted.
+   */
   core.String distributionChannel;
   /** A link to an image that can be used as an icon for the product. */
   core.String iconUrl;
   /**
    * Identifies what kind of resource this is. Value: the fixed string
    * "androidenterprise#product".
    */
   core.String kind;
   /**
-   * A string of the form "app:
-   * " - e.g. "app:com.google.android.gm" represents the GMail app.
+   * A string of the form app:<package name>. For example,
+   * app:com.google.android.gm represents the Gmail app.
    */
   core.String productId;
   /**
    * Whether this app can only be installed on devices using the Android for
    * Work container app.
    */
   core.bool requiresContainerApp;
   /** The name of the product. */
   core.String title;
   /**
@@ skipping 150 matching lines @@
     if (permission != null) {
       _json["permission"] = permission.map((value) => (value).toJson()).toList();
     }
     if (productId != null) {
       _json["productId"] = productId;
     }
     return _json;
   }
 }
 
+/** A set of products. */
+class ProductSet {
+  /**
+   * Identifies what kind of resource this is. Value: the fixed string
+   * "androidenterprise#productSet".
+   */
+  core.String kind;
+  /** The list of product IDs making up the set of products. */
+  core.List<core.String> productId;
+
+  ProductSet();
+
+  ProductSet.fromJson(core.Map _json) {
+    if (_json.containsKey("kind")) {
+      kind = _json["kind"];
+    }
+    if (_json.containsKey("productId")) {
+      productId = _json["productId"];
+    }
+  }
+
+  core.Map toJson() {
+    var _json = new core.Map();
+    if (kind != null) {
+      _json["kind"] = kind;
+    }
+    if (productId != null) {
+      _json["productId"] = productId;
+    }
+    return _json;
+  }
+}
+
 class ProductsApproveRequest {
+  /**
+   * The approval URL that was shown to the user. Only the permissions shown to
+   * the user with that URL will be accepted, which may not be the product's
+   * entire set of permissions. For example, the URL may only display new
+   * permissions from an update after the product was approved, or not include
+   * new permissions if the product was updated since the URL was generated.
+   */
   ApprovalUrlInfo approvalUrlInfo;
 
   ProductsApproveRequest();
 
   ProductsApproveRequest.fromJson(core.Map _json) {
     if (_json.containsKey("approvalUrlInfo")) {
       approvalUrlInfo = new ApprovalUrlInfo.fromJson(_json["approvalUrlInfo"]);
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (approvalUrlInfo != null) {
       _json["approvalUrlInfo"] = (approvalUrlInfo).toJson();
     }
     return _json;
   }
 }
 
 class ProductsGenerateApprovalUrlResponse {
   /**
-   * A iframe-able URL that displays a product's permissions (if any). This URL
-   * can be used to approve the product only once and for a limited time (1
-   * hour), using the Products.approve call. If the product is not currently
-   * approved and has no permissions, this URL will point to an empty page. If
-   * the product is currently approved and all of its permissions (if any) are
-   * also approved, this field will not be populated.
+   * A URL that can be rendered in an iframe to display the permissions (if any)
+   * of a product. This URL can be used to approve the product only once and
+   * only within 24 hours of being generated, using the Products.approve call.
+   * If the product is currently unapproved and has no permissions, this URL
+   * will point to an empty page. If the product is currently approved, a URL
+   * will only be generated if that product has added permissions since it was
+   * last approved, and the URL will only display those new permissions that
+   * have not yet been accepted.
    */
   core.String url;
 
   ProductsGenerateApprovalUrlResponse();
 
   ProductsGenerateApprovalUrlResponse.fromJson(core.Map _json) {
     if (_json.containsKey("url")) {
       url = _json["url"];
     }
   }
@@ skipping 133 matching lines @@
     var _json = new core.Map();
     if (kind != null) {
       _json["kind"] = kind;
     }
     if (user != null) {
       _json["user"] = user.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }