feat(androidenterprise): update the API

yoshi-automation · Benjamin E. Coe · commit 27be4ae2e586 · 2022-12-22T19:11:00.000Z
#### androidenterprise:v1

The following keys were added:
- resources.enterprises.methods.createEnrollmentToken.description
- resources.enterprises.methods.createEnrollmentToken.flatPath
- resources.enterprises.methods.createEnrollmentToken.httpMethod
- resources.enterprises.methods.createEnrollmentToken.id
- resources.enterprises.methods.createEnrollmentToken.parameterOrder
- resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.description
- resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.enum
- resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.enumDescriptions
- resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.location
- resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.type
- resources.enterprises.methods.createEnrollmentToken.parameters.enterpriseId.description
- resources.enterprises.methods.createEnrollmentToken.parameters.enterpriseId.location
- resources.enterprises.methods.createEnrollmentToken.parameters.enterpriseId.required
- resources.enterprises.methods.createEnrollmentToken.parameters.enterpriseId.type
- resources.enterprises.methods.createEnrollmentToken.path
- resources.enterprises.methods.createEnrollmentToken.response.$ref
- resources.enterprises.methods.createEnrollmentToken.scopes
- schemas.CreateEnrollmentTokenResponse.description
- schemas.CreateEnrollmentTokenResponse.id
- schemas.CreateEnrollmentTokenResponse.properties.enrollmentToken.description
- schemas.CreateEnrollmentTokenResponse.properties.enrollmentToken.type
- schemas.CreateEnrollmentTokenResponse.type

The following keys were changed:
- resources.enterprises.methods.pullNotificationSet.parameters.requestMode.description
diff --git a/discovery/androidenterprise-v1.json b/discovery/androidenterprise-v1.json
@@ -383,6 +383,45 @@
             "https://www.googleapis.com/auth/androidenterprise"
           ]
         },
+        "createEnrollmentToken": {
+          "description": "Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.",
+          "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken",
+          "httpMethod": "POST",
+          "id": "androidenterprise.enterprises.createEnrollmentToken",
+          "parameterOrder": [
+            "enterpriseId"
+          ],
+          "parameters": {
+            "deviceType": {
+              "description": "Whether it’s a dedicated device or a knowledge worker device.",
+              "enum": [
+                "unknown",
+                "dedicatedDevice",
+                "knowledgeWorker"
+              ],
+              "enumDescriptions": [
+                "This value is unused",
+                "This device is a dedicated device.",
+                "This device is required to have an authenticated user."
+              ],
+              "location": "query",
+              "type": "string"
+            },
+            "enterpriseId": {
+              "description": "The ID of the enterprise.",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken",
+          "response": {
+            "$ref": "CreateEnrollmentTokenResponse"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/androidenterprise"
+          ]
+        },
         "createWebToken": {
           "description": "Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.",
           "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createWebToken",
@@ -575,7 +614,7 @@
           "parameterOrder": [],
           "parameters": {
             "requestMode": {
-              "description": "The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.",
+              "description": "The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.",
               "enum": [
                 "waitForNotifications",
                 "returnImmediately"
@@ -2610,7 +2649,7 @@
       }
     }
   },
-  "revision": "20221025",
+  "revision": "20221214",
   "rootUrl": "https://androidenterprise.googleapis.com/",
   "schemas": {
     "Administrator": {
@@ -3099,6 +3138,17 @@
       },
       "type": "object"
     },
+    "CreateEnrollmentTokenResponse": {
+      "description": "Response message for create enrollment token.",
+      "id": "CreateEnrollmentTokenResponse",
+      "properties": {
+        "enrollmentToken": {
+          "description": "Enrollment token.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "Device": {
       "description": "A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.",
       "id": "Device",
diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts
@@ -449,6 +449,15 @@ export namespace androidenterprise_v1 {
      */
     variableSet?: Schema$VariableSet[];
   }
+  /**
+   * Response message for create enrollment token.
+   */
+  export interface Schema$CreateEnrollmentTokenResponse {
+    /**
+     * Enrollment token.
+     */
+    enrollmentToken?: string | null;
+  }
   /**
    * A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
    */
@@ -2676,6 +2685,147 @@ export namespace androidenterprise_v1 {
       }
     }
 
+    /**
+     * Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/androidenterprise.googleapis.com
+     * // - Login into gcloud by running:
+     * //   `$ gcloud auth application-default login`
+     * // - Install the npm module by running:
+     * //   `$ npm install googleapis`
+     *
+     * const {google} = require('googleapis');
+     * const androidenterprise = google.androidenterprise('v1');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/androidenterprise'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await androidenterprise.enterprises.createEnrollmentToken({
+     *     // Whether it’s a dedicated device or a knowledge worker device.
+     *     deviceType: 'placeholder-value',
+     *     // The ID of the enterprise.
+     *     enterpriseId: 'placeholder-value',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "enrollmentToken": "my_enrollmentToken"
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
+     *
+     * @param params - Parameters for request
+     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+     * @param callback - Optional callback that handles the response.
+     * @returns A promise if used with async/await, or void if used with a callback.
+     */
+    createEnrollmentToken(
+      params: Params$Resource$Enterprises$Createenrollmenttoken,
+      options: StreamMethodOptions
+    ): GaxiosPromise<Readable>;
+    createEnrollmentToken(
+      params?: Params$Resource$Enterprises$Createenrollmenttoken,
+      options?: MethodOptions
+    ): GaxiosPromise<Schema$CreateEnrollmentTokenResponse>;
+    createEnrollmentToken(
+      params: Params$Resource$Enterprises$Createenrollmenttoken,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    createEnrollmentToken(
+      params: Params$Resource$Enterprises$Createenrollmenttoken,
+      options:
+        | MethodOptions
+        | BodyResponseCallback<Schema$CreateEnrollmentTokenResponse>,
+      callback: BodyResponseCallback<Schema$CreateEnrollmentTokenResponse>
+    ): void;
+    createEnrollmentToken(
+      params: Params$Resource$Enterprises$Createenrollmenttoken,
+      callback: BodyResponseCallback<Schema$CreateEnrollmentTokenResponse>
+    ): void;
+    createEnrollmentToken(
+      callback: BodyResponseCallback<Schema$CreateEnrollmentTokenResponse>
+    ): void;
+    createEnrollmentToken(
+      paramsOrCallback?:
+        | Params$Resource$Enterprises$Createenrollmenttoken
+        | BodyResponseCallback<Schema$CreateEnrollmentTokenResponse>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$CreateEnrollmentTokenResponse>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$CreateEnrollmentTokenResponse>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | GaxiosPromise<Schema$CreateEnrollmentTokenResponse>
+      | GaxiosPromise<Readable> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Enterprises$Createenrollmenttoken;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Enterprises$Createenrollmenttoken;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl =
+        options.rootUrl || 'https://androidenterprise.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (
+              rootUrl +
+              '/androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken'
+            ).replace(/([^:]\/)\/+/g, '$1'),
+            method: 'POST',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['enterpriseId'],
+        pathParams: ['enterpriseId'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$CreateEnrollmentTokenResponse>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$CreateEnrollmentTokenResponse>(
+          parameters
+        );
+      }
+    }
+
     /**
      * Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.
      * @example
@@ -3661,7 +3811,7 @@ export namespace androidenterprise_v1 {
      *
      *   // Do the magic
      *   const res = await androidenterprise.enterprises.pullNotificationSet({
-     *     // The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
+     *     // The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
      *     requestMode: 'placeholder-value',
      *   });
      *   console.log(res.data);
@@ -4329,6 +4479,17 @@ export namespace androidenterprise_v1 {
      */
     enterpriseToken?: string;
   }
+  export interface Params$Resource$Enterprises$Createenrollmenttoken
+    extends StandardParameters {
+    /**
+     * Whether it’s a dedicated device or a knowledge worker device.
+     */
+    deviceType?: string;
+    /**
+     * The ID of the enterprise.
+     */
+    enterpriseId?: string;
+  }
   export interface Params$Resource$Enterprises$Createwebtoken
     extends StandardParameters {
     /**
@@ -4393,7 +4554,7 @@ export namespace androidenterprise_v1 {
   export interface Params$Resource$Enterprises$Pullnotificationset
     extends StandardParameters {
     /**
-     * The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
+     * The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
      */
     requestMode?: string;
   }
