get method

Future<ClientUserInvitation> get(
  1. String accountId,
  2. String clientAccountId,
  3. String invitationId, {
  4. String? $fields,
})

Retrieves an existing client user invitation.

Request parameters:

accountId - Numerical account ID of the client's sponsor buyer. (required)

clientAccountId - Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)

invitationId - Numerical identifier of the user invitation to retrieve. (required)

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

Completes with a ClientUserInvitation.

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

  final url_ = 'v2beta1/accounts/' +
      commons.escapeVariable('$accountId') +
      '/clients/' +
      commons.escapeVariable('$clientAccountId') +
      '/invitations/' +
      commons.escapeVariable('$invitationId');

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