GoogleApi.SmartDeviceManagement.V1.Api.Enterprises (google_api_smart_device_management v0.3.0) View Source
API calls for all endpoints tagged Enterprises
.
Link to this section Summary
Functions
Executes a command to device managed by the enterprise.
Gets a device managed by the enterprise.
Lists devices managed by the enterprise.
Gets a structure managed by the enterprise.
Lists structures managed by the enterprise.
Gets a room managed by the enterprise.
Lists rooms managed by the enterprise.
Link to this section Functions
Link to this function
smartdevicemanagement_enterprises_devices_execute_command(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
smartdevicemanagement_enterprises_devices_execute_command( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Executes a command to device managed by the enterprise.
Parameters
-
connection
(type:GoogleApi.SmartDeviceManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the device requested. For example: "enterprises/XYZ/devices/123" -
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.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse{}}
on success -
{:error, info}
on failure
Link to this function
smartdevicemanagement_enterprises_devices_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
smartdevicemanagement_enterprises_devices_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1Device.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets a device managed by the enterprise.
Parameters
-
connection
(type:GoogleApi.SmartDeviceManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the device requested. For example: "enterprises/XYZ/devices/123" -
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.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1Device{}}
on success -
{:error, info}
on failure
Link to this function
smartdevicemanagement_enterprises_devices_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
smartdevicemanagement_enterprises_devices_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ListDevicesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists devices managed by the enterprise.
Parameters
-
connection
(type:GoogleApi.SmartDeviceManagement.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The parent enterprise to list devices under. E.g. "enterprises/XYZ". -
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"). -
:filter
(type:String.t
) - Optional filter to list devices. Filters can match the exact assignee (could be a structure or a room). E.g. 'assignee=enterprises/XYZ/structures/abc' Also could filter by parent (group): 'parent=enterprises/XYZ/groups/jkl' or filter by device custom name (substring match): 'customName=wing' -
:pageSize
(type:integer()
) - Optional requested page size. Server may return fewer devices than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - Optional token of the page to retrieve.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ListDevicesResponse{}}
on success -
{:error, info}
on failure
Link to this function
smartdevicemanagement_enterprises_structures_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
smartdevicemanagement_enterprises_structures_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1Structure.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets a structure managed by the enterprise.
Parameters
-
connection
(type:GoogleApi.SmartDeviceManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the structure requested. For example: "enterprises/XYZ/structures/ABC". -
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.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1Structure{}}
on success -
{:error, info}
on failure
Link to this function
smartdevicemanagement_enterprises_structures_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
smartdevicemanagement_enterprises_structures_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ListStructuresResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists structures managed by the enterprise.
Parameters
-
connection
(type:GoogleApi.SmartDeviceManagement.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The parent enterprise to list structures under. E.g. "enterprises/XYZ". -
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"). -
:filter
(type:String.t
) - Optional filter to list structures. Filters can match the exact album assigned to the structure. E.g. 'album=enterprises/XYZ/albums/abc' It also support filtering by parent (only groups for now): E.g. 'parent=enterprises/XYZ/groups/124' -
:pageSize
(type:integer()
) - Requested page size. Server may return fewer structures than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - The token of the page to retrieve.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ListStructuresResponse{}}
on success -
{:error, info}
on failure
Link to this function
smartdevicemanagement_enterprises_structures_rooms_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
smartdevicemanagement_enterprises_structures_rooms_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1Room.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets a room managed by the enterprise.
Parameters
-
connection
(type:GoogleApi.SmartDeviceManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the room requested. For example: "enterprises/XYZ/structures/ABC/rooms/123". -
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.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1Room{}}
on success -
{:error, info}
on failure
Link to this function
smartdevicemanagement_enterprises_structures_rooms_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
smartdevicemanagement_enterprises_structures_rooms_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ListRoomsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists rooms managed by the enterprise.
Parameters
-
connection
(type:GoogleApi.SmartDeviceManagement.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The parent resource name of the rooms requested. For example: "enterprises/XYZ/structures/ABC". -
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"). -
:pageSize
(type:integer()
) - Requested page size. Server may return fewer rooms than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - The token of the page to retrieve.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SmartDeviceManagement.V1.Model.GoogleHomeEnterpriseSdmV1ListRoomsResponse{}}
on success -
{:error, info}
on failure