updateOrganizationMembershipMetadata method
Future<OrganizationMembership?>
updateOrganizationMembershipMetadata(
- String organizationId,
- String userId, {
- UpdateOrganizationMembershipMetadataRequest? updateOrganizationMembershipMetadataRequest,
Merge and update organization membership metadata
Update an organization membership's metadata attributes by merging existing values with the provided parameters. Metadata values will be updated via a deep merge. Deep means that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to null.
Parameters:
-
String organizationId (required): The ID of the organization the membership belongs to
-
String userId (required): The ID of the user that this membership belongs to
-
UpdateOrganizationMembershipMetadataRequest updateOrganizationMembershipMetadataRequest:
Implementation
Future<OrganizationMembership?> updateOrganizationMembershipMetadata(
String organizationId,
String userId, {
UpdateOrganizationMembershipMetadataRequest?
updateOrganizationMembershipMetadataRequest,
}) async {
final response = await updateOrganizationMembershipMetadataWithHttpInfo(
organizationId,
userId,
updateOrganizationMembershipMetadataRequest:
updateOrganizationMembershipMetadataRequest,
);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(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),
'OrganizationMembership',
) as OrganizationMembership;
}
return null;
}