GoogleApi.WorkspaceEvents.V1.Api.Subscriptions (google_api_workspace_events v0.4.1)

View Source

API calls for all endpoints tagged Subscriptions.

Summary

Functions

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

Developer Preview: Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.

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

Developer Preview: Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.

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

Developer Preview: Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.

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

Developer Preview: Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.

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

Developer Preview: Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.

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

Developer Preview: Reactivates a suspended Google Workspace subscription. This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see Reactivate a Google Workspace subscription.

Functions

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

@spec workspaceevents_subscriptions_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.WorkspaceEvents.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Developer Preview: Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.

Parameters

  • connection (type: GoogleApi.WorkspaceEvents.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").
    • :validateOnly (type: boolean()) - Optional. If set to true, validates and previews the request, but doesn't create the subscription.
    • :body (type: GoogleApi.WorkspaceEvents.V1.Model.Subscription.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

@spec workspaceevents_subscriptions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkspaceEvents.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Developer Preview: Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.

Parameters

  • connection (type: GoogleApi.WorkspaceEvents.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the subscription to delete. Format: subscriptions/{subscription}
  • 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").
    • :allowMissing (type: boolean()) - Optional. If set to true and the subscription isn't found, the request succeeds but doesn't delete the subscription.
    • :etag (type: String.t) - Optional. Etag of the subscription. If present, it must match with the server's etag. Otherwise, request fails with the status ABORTED.
    • :validateOnly (type: boolean()) - Optional. If set to true, validates and previews the request, but doesn't delete the subscription.
  • opts (type: keyword()) - Call options

Returns

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

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

@spec workspaceevents_subscriptions_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkspaceEvents.V1.Model.Subscription.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Developer Preview: Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.

Parameters

  • connection (type: GoogleApi.WorkspaceEvents.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the subscription. Format: subscriptions/{subscription}
  • 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.WorkspaceEvents.V1.Model.Subscription{}} on success
  • {:error, info} on failure

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

@spec workspaceevents_subscriptions_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.WorkspaceEvents.V1.Model.ListSubscriptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Developer Preview: Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.

Parameters

  • connection (type: GoogleApi.WorkspaceEvents.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").
    • :filter (type: String.t) - Required. A query filter. You can filter subscriptions by event type (event_types) and target resource (target_resource). You must specify at least one event type in your query. To filter for multiple event types, use the OR operator. To filter by both event type and target resource, use the AND operator and specify the full resource name, such as //chat.googleapis.com/spaces/{space}. For example, the following queries are valid: event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" event_types:"google.workspace.chat.message.v1.created" AND target_resource="//chat.googleapis.com/spaces/{space}" ( event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" ) AND target_resource="//chat.googleapis.com/spaces/{space}" The server rejects invalid queries with an INVALID_ARGUMENT error.
    • :pageSize (type: integer()) - Optional. The maximum number of subscriptions to return. The service might return fewer than this value. If unspecified or set to 0, up to 50 subscriptions are returned. The maximum value is 100. If you specify a value more than 100, the system only returns 100 subscriptions.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous list subscriptions call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.
  • opts (type: keyword()) - Call options

Returns

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

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

@spec workspaceevents_subscriptions_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkspaceEvents.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Developer Preview: Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.

Parameters

  • connection (type: GoogleApi.WorkspaceEvents.V1.Connection.t) - Connection to server
  • name (type: String.t) - Identifier. Resource name of the subscription. Format: subscriptions/{subscription}
  • 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 field to update. If omitted, updates any fields included in the request. You can update one of the following fields in a subscription: expire_time: The timestamp when the subscription expires. ttl: The time-to-live (TTL) or duration of the subscription. event_types: The list of event types to receive about the target resource. To fully replace the subscription (the equivalent of PUT), use ``. Any omitted fields are updated with empty values.
    • :validateOnly (type: boolean()) - Optional. If set to true, validates and previews the request, but doesn't update the subscription.
    • :body (type: GoogleApi.WorkspaceEvents.V1.Model.Subscription.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

@spec workspaceevents_subscriptions_reactivate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkspaceEvents.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Developer Preview: Reactivates a suspended Google Workspace subscription. This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see Reactivate a Google Workspace subscription.

Parameters

  • connection (type: GoogleApi.WorkspaceEvents.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the subscription. Format: subscriptions/{subscription}
  • 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.WorkspaceEvents.V1.Model.ReactivateSubscriptionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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