public interface AppsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<UserSessionInfo> |
changeApp(SignIn signIn)
Change the app currently associate with the signed in caller's session.
|
retrofit2.Call<Message> |
createSynapseProjectTeam(List<String> string)
Create new Synapse project and team
Create a new Synapse project and team for the provided Synapse user, and grant permissions to the Bridge exporter to export Bridge data into that app.
|
retrofit2.Call<EmailVerificationStatus> |
getAppEmailStatus()
SES email verification status
Consents will be emailed from the support email address you provide.
|
retrofit2.Call<AppList> |
getAppMemberships()
Get the list of apps that are accessible to the signed in user via a shared Synapse user ID
Return a summary of all apps that are accessible to the authenticated caller via a shared Synapse user ID.
|
retrofit2.Call<CmsPublicKey> |
getAppPublicCsmKey()
Get the public key CMS block for this app
|
retrofit2.Call<AppList> |
getApps(Boolean summary)
Get all apps The summary must be true if this call is made without authentication.
|
retrofit2.Call<AppConfig> |
getConfigForApp(String appId)
Get the config for the current version of the app making the request.
|
retrofit2.Call<UploadList> |
getUploads(DateTime startTime,
DateTime endTime,
Integer pageSize,
String offsetKey)
Get uploads for the app
|
retrofit2.Call<App> |
getUsersApp()
Get an app
Get the app of the currently signed in user account.
|
retrofit2.Call<Exporter3Configuration> |
initExporter3()
Initializes configs and Synapse resources for Exporter 3.0.
|
retrofit2.Call<Message> |
resendVerifyEmail(String type)
Resends the verification email for the app's email.
|
retrofit2.Call<ExporterSubscriptionResult> |
subscribeToCreateStudyNotifications(ExporterSubscriptionRequest exporterSubscriptionRequest)
Subscribe to be notified when a study is initialized for Exporter 3.0 in caller's app.
|
retrofit2.Call<ExporterSubscriptionResult> |
subscribeToExportNotificationsForApp(ExporterSubscriptionRequest exporterSubscriptionRequest)
Subscribe to be notified when health data is exported to any Synapse projects in the app.
|
retrofit2.Call<VersionHolder> |
updateUsersApp(App app)
Update an app
Update the app of the currently signed in developer account.
|
retrofit2.Call<Message> |
verifyEmailForApp(String appId,
String token,
String type)
Verifies the app's email
Verifies the app's email.
|
retrofit2.Call<EmailVerificationStatus> |
verifySenderEmail()
Trigger SES email verification process
Amazon SES will attempt to verify that it can send email from your support email address.
|
@Headers(value="Content-Type:application/json") @POST(value="v3/auth/app") retrofit2.Call<UserSessionInfo> changeApp(@Body SignIn signIn)
signIn
- Sign in information (appId only) (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/synapseProject") retrofit2.Call<Message> createSynapseProjectTeam(@Body List<String> string)
string
- (required)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/self/emailStatus") retrofit2.Call<EmailVerificationStatus> getAppEmailStatus()
@Headers(value="Content-Type:application/json") @GET(value="v1/apps/memberships") retrofit2.Call<AppList> getAppMemberships()
@Headers(value="Content-Type:application/json") @GET(value="v1/apps/self/publicKey") retrofit2.Call<CmsPublicKey> getAppPublicCsmKey()
@Headers(value="Content-Type:application/json") @GET(value="v1/apps") retrofit2.Call<AppList> getApps(@Query(value="summary") Boolean summary)
summary
- If true, anyone can call this endpoint and return a list of truncated app objects (name and ID only). Otherwise, caller must be an admin. (optional)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/{appId}/appconfig") retrofit2.Call<AppConfig> getConfigForApp(@Path(value="appId") String appId)
appId
- App ID (required)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/self/uploads") retrofit2.Call<UploadList> getUploads(@Query(value="startTime") DateTime startTime, @Query(value="endTime") DateTime endTime, @Query(value="pageSize") Integer pageSize, @Query(value="offsetKey") String offsetKey)
startTime
- (required)endTime
- (required)pageSize
- maximum number of records in each returned page (optional, default to 50)offsetKey
- next page start key for pagination (optional)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/self") retrofit2.Call<App> getUsersApp()
@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/exporter3") retrofit2.Call<Exporter3Configuration> initExporter3()
@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/emails/resendVerify") retrofit2.Call<Message> resendVerifyEmail(@Query(value="type") String type)
type
- Type of email that should resend email verification. (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/exporter3/notifications/study/subscribe") retrofit2.Call<ExporterSubscriptionResult> subscribeToCreateStudyNotifications(@Body ExporterSubscriptionRequest exporterSubscriptionRequest)
exporterSubscriptionRequest
- Subscription request attributes. (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/exporter3/notifications/export/subscribe") retrofit2.Call<ExporterSubscriptionResult> subscribeToExportNotificationsForApp(@Body ExporterSubscriptionRequest exporterSubscriptionRequest)
exporterSubscriptionRequest
- Subscription request attributes. (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self") retrofit2.Call<VersionHolder> updateUsersApp(@Body App app)
app
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/{appId}/emails/verify") retrofit2.Call<Message> verifyEmailForApp(@Path(value="appId") String appId, @Query(value="token") String token, @Query(value="type") String type)
appId
- App ID (required)token
- Email verification token (required)type
- Type of email that should resend email verification. (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/verifyEmail") retrofit2.Call<EmailVerificationStatus> verifySenderEmail()
Copyright © 2023 Sage Bionetworks. All rights reserved.