google_api_android_enterprise v0.0.1 GoogleApi.AndroidEnterprise.V1.Api.Storelayoutclusters View Source
API calls for all endpoints tagged Storelayoutclusters
.
Link to this section Summary
Functions
Deletes a cluster
Retrieves details of a cluster
Inserts a new cluster in a page
Retrieves the details of all clusters on the specified page
Updates a cluster. This method supports patch semantics
Link to this section Functions
androidenterprise_storelayoutclusters_delete(Tesla.Env.client, String.t, String.t, String.t, keyword) :: {:ok, nil} | {:error, Tesla.Env.t}
Deletes a cluster.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- page_id (String): The ID of the page.
- cluster_id (String): The ID of the cluster.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %{}} on success {:error, info} on failure
androidenterprise_storelayoutclusters_get(Tesla.Env.client, String.t, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t} | {:error, Tesla.Env.t}
Retrieves details of a cluster.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- page_id (String): The ID of the page.
- cluster_id (String): The ID of the cluster.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}} on success {:error, info} on failure
androidenterprise_storelayoutclusters_insert(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t} | {:error, Tesla.Env.t}
Inserts a new cluster in a page.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- page_id (String): The ID of the page.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (StoreCluster):
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}} on success {:error, info} on failure
androidenterprise_storelayoutclusters_list(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreLayoutClustersListResponse.t} | {:error, Tesla.Env.t}
Retrieves the details of all clusters on the specified page.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- page_id (String): The ID of the page.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreLayoutClustersListResponse{}} on success {:error, info} on failure
androidenterprise_storelayoutclusters_patch(Tesla.Env.client, String.t, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t} | {:error, Tesla.Env.t}
Updates a cluster. This method supports patch semantics.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- page_id (String): The ID of the page.
- cluster_id (String): The ID of the cluster.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (StoreCluster):
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}} on success {:error, info} on failure
androidenterprise_storelayoutclusters_update(Tesla.Env.client, String.t, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t} | {:error, Tesla.Env.t}
Updates a cluster.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- page_id (String): The ID of the page.
- cluster_id (String): The ID of the cluster.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (StoreCluster):
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}} on success {:error, info} on failure