onboard method

Future<void> onboard(OnboardBuyOnGoogleProgramRequest request, String merchantId, String regionCode, { String? $fields, })

Onboards the BoG program in your Merchant Center account.

By using this method, you agree to the Terms of Service. Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.

request - The metadata request object.

Request parameters:

merchantId - Required. The ID of the account.

regionCode - Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.

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

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<void> onboard(
  OnboardBuyOnGoogleProgramRequest request,
  core.String merchantId,
  core.String regionCode, {
  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') +
      '/buyongoogleprograms/' +
      commons.escapeVariable('$regionCode') +
      '/onboard';

  await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
    downloadOptions: null,
  );
}