setVisibility method

Future<DynamiteResponse<ProfileApiSetVisibilityResponseApplicationJson, void>> setVisibility({ required String paramId, required String visibility, required String targetUserId, 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:

• paramId ID of the parameter.
• visibility New visibility.
• 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:

• $setVisibility_Request for the request send by this method.
• $setVisibility_Serializer for a converter to parse the Response from an executed request.

Implementation

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

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