GoogleApi.AndroidEnterprise.V1.Api.Storelayoutclusters (google_api_android_enterprise v0.31.0)

API calls for all endpoints tagged Storelayoutclusters.

Summary

Functions

androidenterprise_storelayoutclusters_delete(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])

Deletes a cluster.

androidenterprise_storelayoutclusters_get(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])

Retrieves details of a cluster.

androidenterprise_storelayoutclusters_insert(connection, enterprise_id, page_id, optional_params \\ [], opts \\ [])

Inserts a new cluster in a page.

androidenterprise_storelayoutclusters_list(connection, enterprise_id, page_id, optional_params \\ [], opts \\ [])

Retrieves the details of all clusters on the specified page.

androidenterprise_storelayoutclusters_update(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])

Updates a cluster.

Functions

androidenterprise_storelayoutclusters_delete(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])

@spec androidenterprise_storelayoutclusters_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes a cluster.

Parameters

connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
enterprise_id (type: String.t) - The ID of the enterprise.
page_id (type: String.t) - The ID of the page.
cluster_id (type: String.t) - The ID of the cluster.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

androidenterprise_storelayoutclusters_get(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])

@spec androidenterprise_storelayoutclusters_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves details of a cluster.

Parameters

connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
enterprise_id (type: String.t) - The ID of the enterprise.
page_id (type: String.t) - The ID of the page.
cluster_id (type: String.t) - The ID of the cluster.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}} on success
{:error, info} on failure

androidenterprise_storelayoutclusters_insert(connection, enterprise_id, page_id, optional_params \\ [], opts \\ [])

@spec androidenterprise_storelayoutclusters_insert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a new cluster in a page.

Parameters

connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
enterprise_id (type: String.t) - The ID of the enterprise.
page_id (type: String.t) - The ID of the page.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}} on success
{:error, info} on failure

androidenterprise_storelayoutclusters_list(connection, enterprise_id, page_id, optional_params \\ [], opts \\ [])

@spec androidenterprise_storelayoutclusters_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AndroidEnterprise.V1.Model.StoreLayoutClustersListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the details of all clusters on the specified page.

Parameters

connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
enterprise_id (type: String.t) - The ID of the enterprise.
page_id (type: String.t) - The ID of the page.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreLayoutClustersListResponse{}} on success
{:error, info} on failure

androidenterprise_storelayoutclusters_update(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])

@spec androidenterprise_storelayoutclusters_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a cluster.

Parameters

connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
enterprise_id (type: String.t) - The ID of the enterprise.
page_id (type: String.t) - The ID of the page.
cluster_id (type: String.t) - The ID of the cluster.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}} on success
{:error, info} on failure