View Source GoogleApi.EssentialContacts.V1.Api.Organizations (google_api_essential_contacts v0.3.0)
API calls for all endpoints tagged Organizations
.
Summary
Functions
Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
Adds a new contact for a resource.
Deletes a contact.
Gets a single contact.
Lists the contacts that have been set on a resource.
Updates a contact. Note: A contact's email address cannot be changed.
Allows a contact admin to send a test message to contact to verify that it has been configured correctly.
Functions
essentialcontacts_organizations_contacts_compute(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec essentialcontacts_organizations_contacts_compute( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1ComputeContactsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
Parameters
-
connection
(type:GoogleApi.EssentialContacts.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} -
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"). -
:notificationCategories
(type:list(String.t)
) - The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned. -
:pageSize
(type:integer()
) - Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence ofnext_page_token
in the response indicates that more results might be available. If not specified, the default page_size is 100. -
:pageToken
(type:String.t
) - Optional. If present, retrieves the next batch of results from the preceding call to this method.page_token
must be the value ofnext_page_token
from the previous response. The values of other method parameters should be identical to those in the previous call.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1ComputeContactsResponse{}}
on success -
{:error, info}
on failure
essentialcontacts_organizations_contacts_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec essentialcontacts_organizations_contacts_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1Contact.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Adds a new contact for a resource.
Parameters
-
connection
(type:GoogleApi.EssentialContacts.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} -
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.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1Contact.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1Contact{}}
on success -
{:error, info}
on failure
essentialcontacts_organizations_contacts_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec essentialcontacts_organizations_contacts_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.EssentialContacts.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a contact.
Parameters
-
connection
(type:GoogleApi.EssentialContacts.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} -
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.EssentialContacts.V1.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
essentialcontacts_organizations_contacts_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec essentialcontacts_organizations_contacts_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1Contact.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a single contact.
Parameters
-
connection
(type:GoogleApi.EssentialContacts.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} -
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.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1Contact{}}
on success -
{:error, info}
on failure
essentialcontacts_organizations_contacts_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec essentialcontacts_organizations_contacts_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1ListContactsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the contacts that have been set on a resource.
Parameters
-
connection
(type:GoogleApi.EssentialContacts.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} -
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()
) - Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence ofnext_page_token
in the response indicates that more results might be available. If not specified, the default page_size is 100. -
:pageToken
(type:String.t
) - Optional. If present, retrieves the next batch of results from the preceding call to this method.page_token
must be the value ofnext_page_token
from the previous response. The values of other method parameters should be identical to those in the previous call.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1ListContactsResponse{}}
on success -
{:error, info}
on failure
essentialcontacts_organizations_contacts_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec essentialcontacts_organizations_contacts_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1Contact.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a contact. Note: A contact's email address cannot be changed.
Parameters
-
connection
(type:GoogleApi.EssentialContacts.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} -
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"). -
:updateMask
(type:String.t
) - Optional. The update mask applied to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask -
:body
(type:GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1Contact.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1Contact{}}
on success -
{:error, info}
on failure
essentialcontacts_organizations_contacts_send_test_message(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec essentialcontacts_organizations_contacts_send_test_message( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.EssentialContacts.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Allows a contact admin to send a test message to contact to verify that it has been configured correctly.
Parameters
-
connection
(type:GoogleApi.EssentialContacts.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} -
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.EssentialContacts.V1.Model.GoogleCloudEssentialcontactsV1SendTestMessageRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.EssentialContacts.V1.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure