delete method

Future<Empty> delete(
  1. String resourceName, {
  2. bool? deleteContacts,
  3. String? $fields,
})

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

Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.

Request parameters:

resourceName - Required. The resource name of the contact group to delete. Value must have pattern ^contactGroups/\[^/\]+$.

deleteContacts - Optional. Set to true to also delete the contacts in the specified group.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Empty.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Empty> delete(
  core.String resourceName, {
  core.bool? deleteContacts,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (deleteContacts != null) 'deleteContacts': ['${deleteContacts}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$resourceName');

  final response_ = await _requester.request(
    url_,
    'DELETE',
    queryParams: queryParams_,
  );
  return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}