@maxim_mazurok/gapi.client.androiddeviceprovisioning-v1 0.0.20220808

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.androiddeviceprovisioning-v1",
+  "version": "0.0.20220808",
+  "description": "TypeScript typings for Android Device Provisioning Partner API v1",
+  "license": "MIT",
+  "author": {
+    "email": "maxim@mazurok.com",
+    "name": "Maxim Mazurok",
+    "url": "https://maxim.mazurok.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,57 @@
+# TypeScript typings for Android Device Provisioning Partner API v1
+
+Automates Android zero-touch enrollment for device resellers, customers, and EMMs.
+For detailed description please check [documentation](https://developers.google.com/zero-touch/).
+
+## Installing
+
+Install typings for Android Device Provisioning Partner API:
+
+```
+npm install @types/gapi.client.androiddeviceprovisioning-v1 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load('https://androiddeviceprovisioning.googleapis.com/$discovery/rest?version=v1', () => {
+  // now we can use:
+  // gapi.client.androiddeviceprovisioning
+});
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('androiddeviceprovisioning', 'v1', () => {
+  // now we can use:
+  // gapi.client.androiddeviceprovisioning
+});
+```
+
+
+
+After that you can use Android Device Provisioning Partner API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Lists the user's customer accounts.
+*/
+await gapi.client.androiddeviceprovisioning.customers.list({  });
+
+/*
+Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+*/
+await gapi.client.androiddeviceprovisioning.operations.get({ name: "name",  });
+```

package/tests.ts

@@ -0,0 +1,331 @@
+/* This is stub file for gapi.client.androiddeviceprovisioning-v1 definition tests */
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+
+// Revision: 20220808
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://androiddeviceprovisioning.googleapis.com/$discovery/rest?version=v1');
+    /** now we can use gapi.client.androiddeviceprovisioning */
+
+    run();
+
+    async function run() {
+        /** Lists the user's customer accounts. */
+        await gapi.client.androiddeviceprovisioning.customers.list({
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /** Creates a new configuration. Once created, a customer can apply the configuration to devices. */
+        await gapi.client.androiddeviceprovisioning.customers.configurations.create({
+            parent: "Test string",
+        }, {
+            companyName: "Test string",
+            configurationId: "Test string",
+            configurationName: "Test string",
+            contactEmail: "Test string",
+            contactPhone: "Test string",
+            customMessage: "Test string",
+            dpcExtras: "Test string",
+            dpcResourcePath: "Test string",
+            isDefault: true,
+            name: "Test string",
+        });
+        /** Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied. */
+        await gapi.client.androiddeviceprovisioning.customers.configurations.delete({
+            name: "Test string",
+        });
+        /** Gets the details of a configuration. */
+        await gapi.client.androiddeviceprovisioning.customers.configurations.get({
+            name: "Test string",
+        });
+        /** Lists a customer's configurations. */
+        await gapi.client.androiddeviceprovisioning.customers.configurations.list({
+            parent: "Test string",
+        });
+        /** Updates a configuration's field values. */
+        await gapi.client.androiddeviceprovisioning.customers.configurations.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            companyName: "Test string",
+            configurationId: "Test string",
+            configurationName: "Test string",
+            contactEmail: "Test string",
+            contactPhone: "Test string",
+            customMessage: "Test string",
+            dpcExtras: "Test string",
+            dpcResourcePath: "Test string",
+            isDefault: true,
+            name: "Test string",
+        });
+        /**
+         * Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first
+         * boot, or next factory reset.
+         */
+        await gapi.client.androiddeviceprovisioning.customers.devices.applyConfiguration({
+            parent: "Test string",
+        }, {
+            configuration: "Test string",
+            device: {
+                deviceId: "Test string",
+                deviceIdentifier: {
+                    imei: "Test string",
+                    manufacturer: "Test string",
+                    meid: "Test string",
+                    model: "Test string",
+                    serialNumber: "Test string",
+                },
+            },
+        });
+        /** Gets the details of a device. */
+        await gapi.client.androiddeviceprovisioning.customers.devices.get({
+            name: "Test string",
+        });
+        /** Lists a customer's devices. */
+        await gapi.client.androiddeviceprovisioning.customers.devices.list({
+            pageSize: "Test string",
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Removes a configuration from device. */
+        await gapi.client.androiddeviceprovisioning.customers.devices.removeConfiguration({
+            parent: "Test string",
+        }, {
+            device: {
+                deviceId: "Test string",
+                deviceIdentifier: {
+                    imei: "Test string",
+                    manufacturer: "Test string",
+                    meid: "Test string",
+                    model: "Test string",
+                    serialNumber: "Test string",
+                },
+            },
+        });
+        /**
+         * Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch
+         * enrollment again.
+         */
+        await gapi.client.androiddeviceprovisioning.customers.devices.unclaim({
+            parent: "Test string",
+        }, {
+            device: {
+                deviceId: "Test string",
+                deviceIdentifier: {
+                    imei: "Test string",
+                    manufacturer: "Test string",
+                    meid: "Test string",
+                    model: "Test string",
+                    serialNumber: "Test string",
+                },
+            },
+        });
+        /** Lists the DPCs (device policy controllers) that support zero-touch enrollment. */
+        await gapi.client.androiddeviceprovisioning.customers.dpcs.list({
+            parent: "Test string",
+        });
+        /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
+        await gapi.client.androiddeviceprovisioning.operations.get({
+            name: "Test string",
+        });
+        /**
+         * Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their
+         * zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.
+         */
+        await gapi.client.androiddeviceprovisioning.partners.customers.create({
+            parent: "Test string",
+        }, {
+            customer: {
+                adminEmails: [
+                    "Test string"
+                ],
+                companyId: "Test string",
+                companyName: "Test string",
+                languageCode: "Test string",
+                name: "Test string",
+                ownerEmails: [
+                    "Test string"
+                ],
+                skipWelcomeEmail: true,
+                termsStatus: "Test string",
+            },
+        });
+        /**
+         * Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled
+         * themselves using the portal.
+         */
+        await gapi.client.androiddeviceprovisioning.partners.customers.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            partnerId: "Test string",
+        });
+        /** Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error. */
+        await gapi.client.androiddeviceprovisioning.partners.devices.claim({
+            partnerId: "Test string",
+        }, {
+            customerId: "Test string",
+            deviceIdentifier: {
+                imei: "Test string",
+                manufacturer: "Test string",
+                meid: "Test string",
+                model: "Test string",
+                serialNumber: "Test string",
+            },
+            deviceMetadata: {
+                entries: {
+                    A: "Test string"
+                },
+            },
+            sectionType: "Test string",
+        });
+        /**
+         * Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch
+         * operations](/zero-touch/guides/how-it-works#operations).
+         */
+        await gapi.client.androiddeviceprovisioning.partners.devices.claimAsync({
+            partnerId: "Test string",
+        }, {
+            claims: [
+                {
+                    customerId: "Test string",
+                    deviceIdentifier: {
+                        imei: "Test string",
+                        manufacturer: "Test string",
+                        meid: "Test string",
+                        model: "Test string",
+                        serialNumber: "Test string",
+                    },
+                    deviceMetadata: {
+                        entries: {
+                            A: "Test string"
+                        },
+                    },
+                    sectionType: "Test string",
+                }
+            ],
+        });
+        /** Finds devices by hardware identifiers, such as IMEI. */
+        await gapi.client.androiddeviceprovisioning.partners.devices.findByIdentifier({
+            partnerId: "Test string",
+        }, {
+            deviceIdentifier: {
+                imei: "Test string",
+                manufacturer: "Test string",
+                meid: "Test string",
+                model: "Test string",
+                serialNumber: "Test string",
+            },
+            limit: "Test string",
+            pageToken: "Test string",
+        });
+        /**
+         * Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from
+         * other resellers don't appear in the results.
+         */
+        await gapi.client.androiddeviceprovisioning.partners.devices.findByOwner({
+            partnerId: "Test string",
+        }, {
+            customerId: [
+                "Test string"
+            ],
+            limit: "Test string",
+            pageToken: "Test string",
+            sectionType: "Test string",
+        });
+        /** Gets a device. */
+        await gapi.client.androiddeviceprovisioning.partners.devices.get({
+            name: "Test string",
+        });
+        /** Updates reseller metadata associated with the device. */
+        await gapi.client.androiddeviceprovisioning.partners.devices.metadata({
+            deviceId: "Test string",
+            metadataOwnerId: "Test string",
+        }, {
+            deviceMetadata: {
+                entries: {
+                    A: "Test string"
+                },
+            },
+        });
+        /** Unclaims a device from a customer and removes it from zero-touch enrollment. */
+        await gapi.client.androiddeviceprovisioning.partners.devices.unclaim({
+            partnerId: "Test string",
+        }, {
+            deviceId: "Test string",
+            deviceIdentifier: {
+                imei: "Test string",
+                manufacturer: "Test string",
+                meid: "Test string",
+                model: "Test string",
+                serialNumber: "Test string",
+            },
+            sectionType: "Test string",
+            vacationModeDays: 42,
+            vacationModeExpireTime: "Test string",
+        });
+        /**
+         * Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch
+         * operations](/zero-touch/guides/how-it-works#operations).
+         */
+        await gapi.client.androiddeviceprovisioning.partners.devices.unclaimAsync({
+            partnerId: "Test string",
+        }, {
+            unclaims: [
+                {
+                    deviceId: "Test string",
+                    deviceIdentifier: {
+                        imei: "Test string",
+                        manufacturer: "Test string",
+                        meid: "Test string",
+                        model: "Test string",
+                        serialNumber: "Test string",
+                    },
+                    sectionType: "Test string",
+                    vacationModeDays: 42,
+                    vacationModeExpireTime: "Test string",
+                }
+            ],
+        });
+        /**
+         * Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read
+         * [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
+         */
+        await gapi.client.androiddeviceprovisioning.partners.devices.updateMetadataAsync({
+            partnerId: "Test string",
+        }, {
+            updates: [
+                {
+                    deviceId: "Test string",
+                    deviceIdentifier: {
+                        imei: "Test string",
+                        manufacturer: "Test string",
+                        meid: "Test string",
+                        model: "Test string",
+                        serialNumber: "Test string",
+                    },
+                    deviceMetadata: {
+                        entries: {
+                            A: "Test string"
+                        },
+                    },
+                }
+            ],
+        });
+        /** Lists the vendors of the partner. */
+        await gapi.client.androiddeviceprovisioning.partners.vendors.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Lists the customers of the vendor. */
+        await gapi.client.androiddeviceprovisioning.partners.vendors.customers.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+    }
+});

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6", "dom"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "strictFunctionTypes": true
+    },
+    "files": ["index.d.ts", "tests.ts"]
+}

package/tslint.json

@@ -0,0 +1,6 @@
+{
+    "extends": "dtslint/dtslint.json",
+    "rules": {
+        "no-redundant-jsdoc": false
+    }
+}