setVisibility method

Future<DynamiteResponse<ProfileApiSetVisibilityResponseApplicationJson, void>> setVisibility({
  1. required String targetUserId,
  2. required ProfileApiSetVisibilityRequestApplicationJson $body,
  3. bool? oCSAPIRequest,
})

Update the visibility of a parameter.

This endpoint requires password confirmation.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • targetUserId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Visibility updated successfully
  • 400: Updating visibility is not possible
  • 403: Not allowed to edit other users visibility
  • 404: Account not found

See:

Implementation

Future<_i1.DynamiteResponse<ProfileApiSetVisibilityResponseApplicationJson, void>> setVisibility({
  required String targetUserId,
  required ProfileApiSetVisibilityRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) async {
  final _request = $setVisibility_Request(
    targetUserId: targetUserId,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $setVisibility_Serializer();
  return _i1.ResponseConverter<ProfileApiSetVisibilityResponseApplicationJson, void>(_serializer).convert(_response);
}