verifyphonenumber method

Future<VerifyPhoneNumberResponse> verifyphonenumber(
  1. VerifyPhoneNumberRequest request,
  2. String merchantId,
  3. String accountId, {
  4. String? $fields,
})

Validates verification code to verify phone number for the account.

If successful this will overwrite the value of accounts.businessinformation.phoneNumber. Only verified phone number will replace an existing verified phone number.

request - The metadata request object.

Request parameters:

merchantId - Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

accountId - Required. The ID of the account.

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

Completes with a VerifyPhoneNumberResponse.

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<VerifyPhoneNumberResponse> verifyphonenumber(
  VerifyPhoneNumberRequest request,
  core.String merchantId,
  core.String accountId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      commons.escapeVariable('$merchantId') +
      '/accounts/' +
      commons.escapeVariable('$accountId') +
      '/verifyphonenumber';

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