patch method

Future<Placement> patch(
  1. Placement request,
  2. String profileId,
  3. String id, {
  4. String? $fields,
})

Updates an existing placement.

This method supports patch semantics.

request - The metadata request object.

Request parameters:

profileId - User profile ID associated with this request. Value must have pattern ^\[^/\]+$.

id - Required. Placement ID.

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

Completes with a Placement.

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

  final url_ =
      'userprofiles/' + core.Uri.encodeFull('$profileId') + '/placements';

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