AndroidDeviceProvisioning

import { AndroidDeviceProvisioning } from "https://googleapis.deno.dev/v1/androiddeviceprovisioning:v1.ts";

Automates Android zero-touch enrollment for device resellers, customers, and EMMs.

class AndroidDeviceProvisioning {

constructor(client?: CredentialsClient, baseUrl?: string);

async customersConfigurationsCreate(parent: string, req: Configuration): Promise<Configuration>;

async customersConfigurationsDelete(name: string): Promise<Empty>;

async customersConfigurationsGet(name: string): Promise<Configuration>;

async customersConfigurationsList(parent: string): Promise<CustomerListConfigurationsResponse>;

async customersConfigurationsPatch(

name: string,

req: Configuration,

opts?: CustomersConfigurationsPatchOptions,

): Promise<Configuration>;

async customersDevicesApplyConfiguration(parent: string, req: CustomerApplyConfigurationRequest): Promise<Empty>;

async customersDevicesGet(name: string): Promise<Device>;

async customersDevicesList(parent: string, opts?: CustomersDevicesListOptions): Promise<CustomerListDevicesResponse>;

async customersDevicesRemoveConfiguration(parent: string, req: CustomerRemoveConfigurationRequest): Promise<Empty>;

async customersDevicesUnclaim(parent: string, req: CustomerUnclaimDeviceRequest): Promise<Empty>;

async customersDpcsList(parent: string): Promise<CustomerListDpcsResponse>;

async customersList(opts?: CustomersListOptions): Promise<CustomerListCustomersResponse>;

async operationsGet(name: string): Promise<Operation>;

async partnersCustomersCreate(parent: string, req: CreateCustomerRequest): Promise<Company>;

async partnersCustomersList(partnerId: bigint, opts?: PartnersCustomersListOptions): Promise<ListCustomersResponse>;

async partnersDevicesClaim(partnerId: bigint, req: ClaimDeviceRequest): Promise<ClaimDeviceResponse>;

async partnersDevicesClaimAsync(partnerId: bigint, req: ClaimDevicesRequest): Promise<Operation>;

async partnersDevicesFindByIdentifier(partnerId: bigint, req: FindDevicesByDeviceIdentifierRequest): Promise<FindDevicesByDeviceIdentifierResponse>;

async partnersDevicesFindByOwner(partnerId: bigint, req: FindDevicesByOwnerRequest): Promise<FindDevicesByOwnerResponse>;

async partnersDevicesGet(name: string): Promise<Device>;

async partnersDevicesGetSimLockState(partnerId: bigint, req: GetDeviceSimLockStateRequest): Promise<GetDeviceSimLockStateResponse>;

async partnersDevicesMetadata(

deviceId: bigint,

metadataOwnerId: bigint,

req: UpdateDeviceMetadataRequest,

): Promise<DeviceMetadata>;

async partnersDevicesUnclaim(partnerId: bigint, req: UnclaimDeviceRequest): Promise<Empty>;

async partnersDevicesUnclaimAsync(partnerId: bigint, req: UnclaimDevicesRequest): Promise<Operation>;

async partnersDevicesUpdateMetadataAsync(partnerId: bigint, req: UpdateDeviceMetadataInBatchRequest): Promise<Operation>;

async partnersVendorsCustomersList(parent: string, opts?: PartnersVendorsCustomersListOptions): Promise<ListVendorCustomersResponse>;

async partnersVendorsList(parent: string, opts?: PartnersVendorsListOptions): Promise<ListVendorsResponse>;

}

§Constructors

new AndroidDeviceProvisioning(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

customersConfigurationsCreate(parent: string, req: Configuration): Promise<Configuration>

[src]

Creates a new configuration. Once created, a customer can apply the configuration to devices.

@param parent

Required. The customer that manages the configuration. An API resource name in the format customers/[CUSTOMER_ID]. This field has custom validation in CreateConfigurationRequestValidator

customersConfigurationsDelete(name: string): Promise<Empty>

[src]

Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.

@param name

Required. The configuration to delete. An API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. If the configuration is applied to any devices, the API call fails.

customersConfigurationsGet(name: string): Promise<Configuration>

[src]

Gets the details of a configuration.

@param name

Required. The configuration to get. An API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID].

customersConfigurationsList(parent: string): Promise<CustomerListConfigurationsResponse>

[src]

Lists a customer's configurations.

@param parent

Required. The customer that manages the listed configurations. An API resource name in the format customers/[CUSTOMER_ID].

customersConfigurationsPatch(name: string, req: Configuration, opts?: CustomersConfigurationsPatchOptions): Promise<Configuration>

[src]

Updates a configuration's field values.

@param name

Output only. The API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Assigned by the server.

customersDevicesApplyConfiguration(parent: string, req: CustomerApplyConfigurationRequest): Promise<Empty>

[src]

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.

@param parent

Required. The customer managing the device. An API resource name in the format customers/[CUSTOMER_ID].

customersDevicesGet(name: string): Promise<Device>

[src]

Gets the details of a device.

@param name

Required. The device to get. An API resource name in the format customers/[CUSTOMER_ID]/devices/[DEVICE_ID].

customersDevicesList(parent: string, opts?: CustomersDevicesListOptions): Promise<CustomerListDevicesResponse>

[src]

Lists a customer's devices.

@param parent

Required. The customer managing the devices. An API resource name in the format customers/[CUSTOMER_ID].

customersDevicesRemoveConfiguration(parent: string, req: CustomerRemoveConfigurationRequest): Promise<Empty>

[src]

Removes a configuration from device.

@param parent

Required. The customer managing the device in the format customers/[CUSTOMER_ID].

customersDevicesUnclaim(parent: string, req: CustomerUnclaimDeviceRequest): Promise<Empty>

[src]

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.

@param parent

Required. The customer managing the device. An API resource name in the format customers/[CUSTOMER_ID].

customersDpcsList(parent: string): Promise<CustomerListDpcsResponse>

[src]

Lists the DPCs (device policy controllers) that support zero-touch enrollment.

@param parent

Required. The customer that can use the DPCs in configurations. An API resource name in the format customers/[CUSTOMER_ID].

customersList(opts?: CustomersListOptions): Promise<CustomerListCustomersResponse>

[src]

Lists the user's customer accounts.

operationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

partnersCustomersCreate(parent: string, req: CreateCustomerRequest): Promise<Company>

[src]

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.

@param parent

Required. The parent resource ID in the format partners/[PARTNER_ID] that identifies the reseller.

partnersCustomersList(partnerId: bigint, opts?: PartnersCustomersListOptions): Promise<ListCustomersResponse>

[src]

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.

@param partnerId

Required. The ID of the reseller partner.

partnersDevicesClaim(partnerId: bigint, req: ClaimDeviceRequest): Promise<ClaimDeviceResponse>

[src]

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.

@param partnerId

Required. The ID of the reseller partner.

partnersDevicesClaimAsync(partnerId: bigint, req: ClaimDevicesRequest): Promise<Operation>

[src]

Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read Long‑running batch operations.

@param partnerId

Required. The ID of the reseller partner.

partnersDevicesFindByIdentifier(partnerId: bigint, req: FindDevicesByDeviceIdentifierRequest): Promise<FindDevicesByDeviceIdentifierResponse>

[src]

Finds devices by hardware identifiers, such as IMEI.

@param partnerId

Required. The ID of the reseller partner.

partnersDevicesFindByOwner(partnerId: bigint, req: FindDevicesByOwnerRequest): Promise<FindDevicesByOwnerResponse>

[src]

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.

@param partnerId

Required. The ID of the reseller partner.

partnersDevicesGet(name: string): Promise<Device>

[src]

Gets a device.

@param name

Required. The device API resource name in the format partners/[PARTNER_ID]/devices/[DEVICE_ID].

partnersDevicesGetSimLockState(partnerId: bigint, req: GetDeviceSimLockStateRequest): Promise<GetDeviceSimLockStateResponse>

[src]

Gets a device's SIM lock state.

@param partnerId

Required. The ID of the partner.

partnersDevicesMetadata(deviceId: bigint, metadataOwnerId: bigint, req: UpdateDeviceMetadataRequest): Promise<DeviceMetadata>

[src]

Updates reseller metadata associated with the device. Android devices only.

@param deviceId

Required. The ID of the device.

@param metadataOwnerId

Required. The owner of the newly set metadata. Set this to the partner ID.

partnersDevicesUnclaim(partnerId: bigint, req: UnclaimDeviceRequest): Promise<Empty>

[src]

Unclaims a device from a customer and removes it from zero-touch enrollment.

@param partnerId

Required. The ID of the reseller partner.

partnersDevicesUnclaimAsync(partnerId: bigint, req: UnclaimDevicesRequest): Promise<Operation>

[src]

Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read Long‑running batch operations.

@param partnerId

Required. The reseller partner ID.

partnersDevicesUpdateMetadataAsync(partnerId: bigint, req: UpdateDeviceMetadataInBatchRequest): Promise<Operation>

[src]

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. Android Devices only.

@param partnerId

Required. The reseller partner ID.

partnersVendorsCustomersList(parent: string, opts?: PartnersVendorsCustomersListOptions): Promise<ListVendorCustomersResponse>

[src]

Lists the customers of the vendor.

@param parent

Required. The resource name in the format partners/[PARTNER_ID]/vendors/[VENDOR_ID].

partnersVendorsList(parent: string, opts?: PartnersVendorsListOptions): Promise<ListVendorsResponse>

[src]

Lists the vendors of the partner.

@param parent

Required. The resource name in the format partners/[PARTNER_ID].