google_api_people v0.0.1 GoogleApi.People.V1.Api.ContactGroups View Source

API calls for all endpoints tagged ContactGroups.

Link to this section Summary

Functions

Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names

Create a new contact group owned by the authenticated user

Delete an existing contact group owned by the authenticated user by specifying a contact group resource name

Get a specific contact group owned by the authenticated user by specifying a contact group resource name

List all contact groups owned by the authenticated user. Members of the contact groups are not populated

Modify the members of a contact group owned by the authenticated user

Update the name of an existing contact group owned by the authenticated user

Link to this section Functions

Link to this function people_contact_groups_batch_get(connection, opts \\ []) View Source
people_contact_groups_batch_get(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.People.V1.Model.BatchGetContactGroupsResponse.t} |
  {:error, Tesla.Env.t}

Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.

Parameters

  • connection (GoogleApi.People.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :resource_names (List[String]): The resource names of the contact groups to get.
    • :max_members (Integer): Specifies the maximum number of members to return for each group.

Returns

{:ok, %GoogleApi.People.V1.Model.BatchGetContactGroupsResponse{}} on success {:error, info} on failure

Link to this function people_contact_groups_create(connection, opts \\ []) View Source
people_contact_groups_create(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.People.V1.Model.ContactGroup.t} |
  {:error, Tesla.Env.t}

Create a new contact group owned by the authenticated user.

Parameters

  • connection (GoogleApi.People.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :body (CreateContactGroupRequest):

Returns

{:ok, %GoogleApi.People.V1.Model.ContactGroup{}} on success {:error, info} on failure

Link to this function people_contact_groups_delete(connection, contact_groups_id, opts \\ []) View Source
people_contact_groups_delete(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.People.V1.Model.Empty.t} |
  {:error, Tesla.Env.t}

Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.

Parameters

  • connection (GoogleApi.People.V1.Connection): Connection to server
  • contact_groups_id (String): Part of `resourceName`. The resource name of the contact group to delete.
  • opts (KeywordList): [optional] Optional parameters

    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :delete_contacts (Boolean): Set to true to also delete the contacts in the specified group.

Returns

{:ok, %GoogleApi.People.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function people_contact_groups_get(connection, contact_groups_id, opts \\ []) View Source
people_contact_groups_get(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.People.V1.Model.ContactGroup.t} |
  {:error, Tesla.Env.t}

Get a specific contact group owned by the authenticated user by specifying a contact group resource name.

Parameters

  • connection (GoogleApi.People.V1.Connection): Connection to server
  • contact_groups_id (String): Part of `resourceName`. The resource name of the contact group to get.
  • opts (KeywordList): [optional] Optional parameters

    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :max_members (Integer): Specifies the maximum number of members to return.

Returns

{:ok, %GoogleApi.People.V1.Model.ContactGroup{}} on success {:error, info} on failure

Link to this function people_contact_groups_list(connection, opts \\ []) View Source
people_contact_groups_list(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.People.V1.Model.ListContactGroupsResponse.t} |
  {:error, Tesla.Env.t}

List all contact groups owned by the authenticated user. Members of the contact groups are not populated.

Parameters

  • connection (GoogleApi.People.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :sync_token (String): A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
    • :page_token (String): The next_page_token value returned from a previous call to ListContactGroups. Requests the next page of resources.
    • :page_size (Integer): The maximum number of resources to return.

Returns

{:ok, %GoogleApi.People.V1.Model.ListContactGroupsResponse{}} on success {:error, info} on failure

Link to this function people_contact_groups_members_modify(connection, contact_groups_id, opts \\ []) View Source
people_contact_groups_members_modify(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.People.V1.Model.ModifyContactGroupMembersResponse.t} |
  {:error, Tesla.Env.t}

Modify the members of a contact group owned by the authenticated user.

Parameters

  • connection (GoogleApi.People.V1.Connection): Connection to server
  • contact_groups_id (String): Part of `resourceName`. The resource name of the contact group to modify.
  • opts (KeywordList): [optional] Optional parameters

    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :body (ModifyContactGroupMembersRequest):

Returns

{:ok, %GoogleApi.People.V1.Model.ModifyContactGroupMembersResponse{}} on success {:error, info} on failure

Link to this function people_contact_groups_update(connection, contact_groups_id, opts \\ []) View Source
people_contact_groups_update(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.People.V1.Model.ContactGroup.t} |
  {:error, Tesla.Env.t}

Update the name of an existing contact group owned by the authenticated user.

Parameters

  • connection (GoogleApi.People.V1.Connection): Connection to server
  • contact_groups_id (String): Part of `contactGroup.resourceName`. The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>.
  • opts (KeywordList): [optional] Optional parameters

    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :body (UpdateContactGroupRequest):

Returns

{:ok, %GoogleApi.People.V1.Model.ContactGroup{}} on success {:error, info} on failure