patchScheme method

Future<MmScheme?> patchScheme(String schemeId, MmPatchSchemeRequest mmPatchSchemeRequest)

Patch a scheme

Partially update a scheme by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions manage_system permission is required. Minimum server version: 5.0

Parameters:

• String schemeId (required): Scheme GUID

• MmPatchSchemeRequest mmPatchSchemeRequest (required): Scheme object to be updated

Implementation

Future<MmScheme?> patchScheme(
  String schemeId,
  MmPatchSchemeRequest mmPatchSchemeRequest,
) async {
  final response = await patchSchemeWithHttpInfo(
    schemeId,
    mmPatchSchemeRequest,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw MmApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'MmScheme',
    ) as MmScheme;
  }
  return null;
}