getEmailPreferences method

Future<EmailPreferences> getEmailPreferences(
  1. String name, {
  2. String? $fields,
})

Returns the email preferences for a Merchant Center account user.

This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts / * /users/me/emailPreferences alias to get preferences for the authenticated user.

Request parameters:

name - Required. The name of the EmailPreferences resource. Format: accounts/{account}/users/{email}/emailPreferences Value must have pattern ^accounts/\[^/\]+/users/\[^/\]+/emailPreferences$.

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

Completes with a EmailPreferences.

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<EmailPreferences> getEmailPreferences(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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