<commit_before>package org.sagebionetworks.bridge.sdk;

import java.util.List;

import org.sagebionetworks.bridge.sdk.models.ResourceList;
import org.sagebionetworks.bridge.sdk.models.UploadRequest;
import org.sagebionetworks.bridge.sdk.models.UploadSession;
import org.sagebionetworks.bridge.sdk.models.holders.GuidCreatedOnVersionHolder;
import org.sagebionetworks.bridge.sdk.models.holders.IdentifierHolder;
import org.sagebionetworks.bridge.sdk.models.schedules.Schedule;
import org.sagebionetworks.bridge.sdk.models.surveys.Survey;
import org.sagebionetworks.bridge.sdk.models.surveys.SurveyAnswer;
import org.sagebionetworks.bridge.sdk.models.surveys.SurveyResponse;
import org.sagebionetworks.bridge.sdk.models.users.ConsentSignature;
import org.sagebionetworks.bridge.sdk.models.users.ExternalIdentifier;
import org.sagebionetworks.bridge.sdk.models.users.SharingScope;
import org.sagebionetworks.bridge.sdk.models.users.UserProfile;

public interface UserClient {

    /**
     * Retrieve the UserProfile associated with the currently signed in account.
     *
     * @return UserProfile
     */
    public UserProfile getProfile();

    /**
     * Update the UserProfile associated with the currently signed in account.
     *
     * @param profile
     *      changed profile object that will be used to update UserProfile info on Bridge.
     */
    public void saveProfile(UserProfile profile);
    
    /**
     * Add an external participant identifier for the current user. This identifier may be provided by some studies in
     * order to collate research data collected through Bridge with external sources of information about the
     * participant. Bridge does not verify the uniqueness of this identifier. The identifier may be updated, but it
     * cannot be removed at this time.
     * 
     * @param identifier
     *      a unique identifier for this participant in this study, generated by an external authority
     */
    public void addExternalUserIdentifier(ExternalIdentifier identifier);

    /**
     * Consent to research.
     *
     * @param signature
     *          Name, birthdate, and optionally signature image, of consenter's signature.
     * @param scope
     *          Scope of sharing for this consent<commit_msg>Small fix to docs<commit_after>package org.sagebionetworks.bridge.sdk;

import java.util.List;

import org.sagebionetworks.bridge.sdk.models.ResourceList;
import org.sagebionetworks.bridge.sdk.models.UploadRequest;
import org.sagebionetworks.bridge.sdk.models.UploadSession;
import org.sagebionetworks.bridge.sdk.models.holders.GuidCreatedOnVersionHolder;
import org.sagebionetworks.bridge.sdk.models.holders.IdentifierHolder;
import org.sagebionetworks.bridge.sdk.models.schedules.Schedule;
import org.sagebionetworks.bridge.sdk.models.surveys.Survey;
import org.sagebionetworks.bridge.sdk.models.surveys.SurveyAnswer;
import org.sagebionetworks.bridge.sdk.models.surveys.SurveyResponse;
import org.sagebionetworks.bridge.sdk.models.users.ConsentSignature;
import org.sagebionetworks.bridge.sdk.models.users.ExternalIdentifier;
import org.sagebionetworks.bridge.sdk.models.users.SharingScope;
import org.sagebionetworks.bridge.sdk.models.users.UserProfile;

public interface UserClient {

    /**
     * Retrieve the UserProfile associated with the currently signed in account.
     *
     * @return UserProfile
     */
    public UserProfile getProfile();

    /**
     * Update the UserProfile associated with the currently signed in account.
     *
     * @param profile
     *      changed profile object that will be used to update UserProfile info on Bridge.
     */
    public void saveProfile(UserProfile profile);
    
    /**
     * Add an external participant identifier for the current user. This identifier may be provided by some studies in
     * order to collate research data collected through Bridge with external sources of information about the
     * participant. Bridge does not verify the uniqueness of this identifier. The identifier may be updated, but it
     * cannot be removed (if necessary, set it to a deleted value like "N/A").
     * 
     * @param identifier
     *      a unique identifier for this participant in this study, generated by an external authority
     */
    public void addExternalUserIdentifier(ExternalIdentifier identifier);

    /**
     * Consent to research.
     *
     * @param signature
     *          Name, birthdate, and optionally signature image, of consenter's signature.
     * @param scope
     *          Scope of sharing for this consent
{'fraction_non_alphanumeric': 0.07396061269146609, 'fraction_numerical': 0.0, 'mean_word_length': 3.693018480492813, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5525585', 'n_tokens_mistral': 1257, 'n_tokens_neox': 1237, 'n_words': 361}