google_api_android_device_provisioning v0.1.0 GoogleApi.AndroidDeviceProvisioning.V1.Api.Partners View Source

API calls for all endpoints tagged Partners.

Link to this section Summary

Functions

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 API doesn't notify the customer that they have access

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

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

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

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

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

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

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

Link to this section Functions

Link to this function androiddeviceprovisioning_partners_customers_create(connection, parent, opts \\ []) View Source
androiddeviceprovisioning_partners_customers_create(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Company.t()}
  | {:error, Tesla.Env.t()}

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 API doesn't notify the customer that they have access.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • parent (String.t): Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (CreateCustomerRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Company{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_customers_list(connection, partner_id, opts \\ []) View Source
androiddeviceprovisioning_partners_customers_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.ListCustomersResponse.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • partner_id (String.t): Required. The ID of the reseller partner.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.ListCustomersResponse{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_devices_claim(connection, partner_id, opts \\ []) View Source
androiddeviceprovisioning_partners_devices_claim(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.ClaimDeviceResponse.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • partner_id (String.t): Required. The ID of the reseller partner.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (ClaimDeviceRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.ClaimDeviceResponse{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_devices_claim_async(connection, partner_id, opts \\ []) View Source
androiddeviceprovisioning_partners_devices_claim_async(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • partner_id (String.t): Required. The ID of the reseller partner.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (ClaimDevicesRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_devices_find_by_identifier(connection, partner_id, opts \\ []) View Source
androiddeviceprovisioning_partners_devices_find_by_identifier(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok,
   GoogleApi.AndroidDeviceProvisioning.V1.Model.FindDevicesByDeviceIdentifierResponse.t()}
  | {:error, Tesla.Env.t()}

Finds devices by hardware identifiers, such as IMEI.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • partner_id (String.t): Required. The ID of the reseller partner.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (FindDevicesByDeviceIdentifierRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.FindDevicesByDeviceIdentifierResponse{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_devices_find_by_owner(connection, partner_id, opts \\ []) View Source
androiddeviceprovisioning_partners_devices_find_by_owner(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok,
   GoogleApi.AndroidDeviceProvisioning.V1.Model.FindDevicesByOwnerResponse.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • partner_id (String.t): Required. The ID of the reseller partner.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (FindDevicesByOwnerRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.FindDevicesByOwnerResponse{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_devices_metadata(connection, metadata_owner_id, device_id, opts \\ []) View Source
androiddeviceprovisioning_partners_devices_metadata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.DeviceMetadata.t()}
  | {:error, Tesla.Env.t()}

Updates reseller metadata associated with the device.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • metadata_owner_id (String.t): Required. The owner of the newly set metadata. Set this to the partner ID.
  • device_id (String.t): Required. The ID of the reseller partner.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (UpdateDeviceMetadataRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.DeviceMetadata{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_devices_unclaim(connection, partner_id, opts \\ []) View Source
androiddeviceprovisioning_partners_devices_unclaim(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • partner_id (String.t): Required. The ID of the reseller partner.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (UnclaimDeviceRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_devices_unclaim_async(connection, partner_id, opts \\ []) View Source
androiddeviceprovisioning_partners_devices_unclaim_async(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • partner_id (String.t): Required. The reseller partner ID.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (UnclaimDevicesRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function androiddeviceprovisioning_partners_devices_update_metadata_async(connection, partner_id, opts \\ []) View Source
androiddeviceprovisioning_partners_devices_update_metadata_async(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • partner_id (String.t): Required. The reseller partner ID.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :body (UpdateDeviceMetadataInBatchRequest):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation{}} on success {:error, info} on failure