GoogleApi.Chat.V1.Api.Spaces (google_api_chat v0.30.0) View Source

API calls for all endpoints tagged Spaces.

Link to this section Summary

Link to this section Functions

Link to this function

chat_spaces_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Space.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a space.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA
  • 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.Chat.V1.Model.Space{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.ListSpacesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists spaces the caller is a member of.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • 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. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Chat.V1.Model.ListSpacesResponse{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_members_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_members_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Membership.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a membership.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the membership to be retrieved, in the form "spaces//members/". Example: spaces/AAAAAAAAAAAA/members/111111111111111111111
  • 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.Chat.V1.Model.Membership{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_members_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_members_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.ListMembershipsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists human memberships in a space.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the space for which membership list is to be fetched, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA
  • 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. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Chat.V1.Model.ListMembershipsResponse{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_messages_attachments_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_messages_attachments_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Chat.V1.Model.Attachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the metadata of a message attachment. The attachment data is fetched using the media API.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • name (type: String.t) - Resource name of the attachment, in the form "spaces//messages//attachments/*".
  • 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.Chat.V1.Model.Attachment{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_messages_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_messages_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a message.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAMpdlehY
  • 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").
    • :requestId (type: String.t) - Optional. A unique request ID for this message. If a message has already been created in the space with this request ID, the subsequent request will return the existing message and no new message will be created.
    • :threadKey (type: String.t) - Optional. Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Google Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.
    • :body (type: GoogleApi.Chat.V1.Model.Message.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Chat.V1.Model.Message{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_messages_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_messages_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Chat.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a message.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the message to be deleted, in the form "spaces//messages/" Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
  • 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.Chat.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_messages_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_messages_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a message.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the message to be retrieved, in the form "spaces//messages/". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
  • 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.Chat.V1.Model.Message{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_messages_update(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_messages_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a message.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • name (type: String.t) - Resource name in the form spaces/*/messages/*. Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
  • 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) - Required. The field paths to be updated, comma separated if there are multiple. Currently supported field paths: text cards gsuite_message_integration_render_data attachment
    • :body (type: GoogleApi.Chat.V1.Model.Message.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Chat.V1.Model.Message{}} on success
  • {:error, info} on failure
Link to this function

chat_spaces_webhooks(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

chat_spaces_webhooks(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Legacy path for creating message. Calling these will result in a BadRequest response.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAMpdlehY
  • 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").
    • :requestId (type: String.t) - Optional. A unique request ID for this message. If a message has already been created in the space with this request ID, the subsequent request will return the existing message and no new message will be created.
    • :threadKey (type: String.t) - Optional. Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Google Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.
    • :body (type: GoogleApi.Chat.V1.Model.Message.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Chat.V1.Model.Message{}} on success
  • {:error, info} on failure