google_api_admin v0.18.0 GoogleApi.Admin.Directory_v1.Api.Resources View Source
API calls for all endpoints tagged Resources
.
Link to this section Summary
Functions
Deletes a building.
Retrieves a building.
Inserts a building.
Retrieves a list of buildings for an account.
Updates a building. This method supports patch semantics.
Updates a building.
Deletes a calendar resource.
Retrieves a calendar resource.
Inserts a calendar resource.
Retrieves a list of calendar resources for an account.
Updates a calendar resource.
Updates a calendar resource.
Deletes a feature.
Retrieves a feature.
Inserts a feature.
Retrieves a list of features for an account.
Updates a feature. This method supports patch semantics.
Renames a feature.
Link to this section Functions
directory_resources_buildings_delete(connection, customer, building_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_buildings_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a building.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
building_id
(type:String.t
) - The ID of the building to delete. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
directory_resources_buildings_get(connection, customer, building_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_buildings_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Building.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a building.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
building_id
(type:String.t
) - The unique ID of the building to retrieve. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Building{}}
on success -
{:error, info}
on failure
directory_resources_buildings_insert(connection, customer, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_buildings_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Building.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Inserts a building.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:coordinatesSource
(type:String.t
) - Source from which Building.coordinates are derived. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.Building.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Building{}}
on success -
{:error, info}
on failure
directory_resources_buildings_list(connection, customer, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_buildings_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Buildings.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a list of buildings for an account.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:maxResults
(type:integer()
) - Maximum number of results to return. -
:pageToken
(type:String.t
) - Token to specify the next page in the list.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Buildings{}}
on success -
{:error, info}
on failure
directory_resources_buildings_patch(connection, customer, building_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_buildings_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Building.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a building. This method supports patch semantics.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
building_id
(type:String.t
) - The ID of the building to update. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:coordinatesSource
(type:String.t
) - Source from which Building.coordinates are derived. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.Building.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Building{}}
on success -
{:error, info}
on failure
directory_resources_buildings_update(connection, customer, building_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_buildings_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Building.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a building.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
building_id
(type:String.t
) - The ID of the building to update. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:coordinatesSource
(type:String.t
) - Source from which Building.coordinates are derived. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.Building.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Building{}}
on success -
{:error, info}
on failure
directory_resources_calendars_delete(connection, customer, calendar_resource_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_calendars_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a calendar resource.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
calendar_resource_id
(type:String.t
) - The unique ID of the calendar resource to delete. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
directory_resources_calendars_get(connection, customer, calendar_resource_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_calendars_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.CalendarResource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a calendar resource.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
calendar_resource_id
(type:String.t
) - The unique ID of the calendar resource to retrieve. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.CalendarResource{}}
on success -
{:error, info}
on failure
directory_resources_calendars_insert(connection, customer, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_calendars_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.CalendarResource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Inserts a calendar resource.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.CalendarResource.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.CalendarResource{}}
on success -
{:error, info}
on failure
directory_resources_calendars_list(connection, customer, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_calendars_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.CalendarResources.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a list of calendar resources for an account.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:maxResults
(type:integer()
) - Maximum number of results to return. -
:orderBy
(type:String.t
) - Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order. -
:pageToken
(type:String.t
) - Token to specify the next page in the list. -
:query
(type:String.t
) - String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Supported fields include generatedResourceName, name, buildingId, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.CalendarResources{}}
on success -
{:error, info}
on failure
directory_resources_calendars_patch(connection, customer, calendar_resource_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_calendars_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.CalendarResource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a calendar resource.
This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. This method supports patch semantics.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
calendar_resource_id
(type:String.t
) - The unique ID of the calendar resource to update. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.CalendarResource.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.CalendarResource{}}
on success -
{:error, info}
on failure
directory_resources_calendars_update(connection, customer, calendar_resource_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_calendars_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.CalendarResource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a calendar resource.
This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
calendar_resource_id
(type:String.t
) - The unique ID of the calendar resource to update. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.CalendarResource.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.CalendarResource{}}
on success -
{:error, info}
on failure
directory_resources_features_delete(connection, customer, feature_key, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_features_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a feature.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
feature_key
(type:String.t
) - The unique ID of the feature to delete. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
directory_resources_features_get(connection, customer, feature_key, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_features_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Feature.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a feature.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
feature_key
(type:String.t
) - The unique ID of the feature to retrieve. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Feature{}}
on success -
{:error, info}
on failure
directory_resources_features_insert(connection, customer, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_features_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Feature.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Inserts a feature.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.Feature.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Feature{}}
on success -
{:error, info}
on failure
directory_resources_features_list(connection, customer, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_features_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Features.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a list of features for an account.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:maxResults
(type:integer()
) - Maximum number of results to return. -
:pageToken
(type:String.t
) - Token to specify the next page in the list.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Features{}}
on success -
{:error, info}
on failure
directory_resources_features_patch(connection, customer, feature_key, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_features_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Feature.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a feature. This method supports patch semantics.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
feature_key
(type:String.t
) - The unique ID of the feature to update. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.Feature.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Feature{}}
on success -
{:error, info}
on failure
directory_resources_features_rename(connection, customer, old_name, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_features_rename( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Renames a feature.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
old_name
(type:String.t
) - The unique ID of the feature to rename. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.FeatureRename.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
directory_resources_features_update(connection, customer, feature_key, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_resources_features_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Feature.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a feature.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. -
feature_key
(type:String.t
) - The unique ID of the feature to update. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.Feature.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Feature{}}
on success -
{:error, info}
on failure