org.infobip.mobile.messaging.api.appinstance.MobileApiAppInstance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of infobip-mobile-messaging-api-java Show documentation
Mobile Messaging SDK for Android
The newest version!
package org.infobip.mobile.messaging.api.appinstance;

import org.infobip.mobile.messaging.api.support.Generator;
import org.infobip.mobile.messaging.api.support.http.ApiKey;
import org.infobip.mobile.messaging.api.support.http.Body;
import org.infobip.mobile.messaging.api.support.http.HttpRequest;
import org.infobip.mobile.messaging.api.support.http.Path;
import org.infobip.mobile.messaging.api.support.http.Query;
import org.infobip.mobile.messaging.api.support.http.Version;
import org.infobip.mobile.messaging.api.support.http.client.HttpMethod;

import java.util.Map;

/**
 * User and app instance related mobile API.
 * 
 * Usage:
 * 
{@code
 * MobileApiAppInstance mobileApiAppInstance = new Generator.Builder().build().create(MobileApiAppInstance.class);
 * }
 *
 * @see Generator
 * @see Generator.Builder
 */
@ApiKey("${api.key}")
@HttpRequest("/mobile/{version}/appinstance")
@Version("1")
public interface MobileApiAppInstance {

    @HttpRequest(method = HttpMethod.POST)
    @Query(name = "ri", value = "true")
    AppInstance createInstance(@Body AppInstance instance);

    @HttpRequest(method = HttpMethod.PATCH, value = "{regId}")
    void patchInstance(@Path(name = "regId") String regId,
                       @Body Map instance);

    @HttpRequest(method = HttpMethod.GET, value = "{regId}")
    AppInstance getInstance(@Path(name = "regId") String regId);

    @HttpRequest(method = HttpMethod.PATCH, value = "{regId}/user")
    void patchUser(@Path(name = "regId") String regId,
                   @Body Map user);

    @HttpRequest(method = HttpMethod.GET, value = "{regId}/user")
    @Query(name = "ri", value = "true")
    UserBody getUser(@Path(name = "regId") String regId);

    @HttpRequest(method = HttpMethod.POST, value = "{regId}/repersonalize")
    void repersonalize(@Path(name = "regId") String regId,
                       @Body UserPersonalizeBody userPersonalizeBody);

    @HttpRequest(method = HttpMethod.POST, value = "{regId}/depersonalize")
    void depersonalize(@Path(name = "regId") String regId);

    @HttpRequest(method = HttpMethod.POST, value = "{regId}/personalize")
    void personalize(@Path(name = "regId") String regId,
                     @Query(name = "forceDepersonalize", value = "false") boolean forceDepersonalize,
                     @Query(name = "keepAsLead", value = "false") boolean keepAsLead,
                     @Body UserPersonalizeBody userPersonalizeBody);

    @HttpRequest(method = HttpMethod.POST, value = "{regId}/user/events/session")
    void sendUserSessionReport(@Path(name = "regId") String regId,
                               @Body UserSessionEventBody userSessionEventBody);

    @HttpRequest(method = HttpMethod.POST, value = "{regId}/user/events/custom")
    void sendUserCustomEvents(@Path(name = "regId") String regId,
                              @Query(name = "validate", value = "false") boolean validate,
                              @Body UserCustomEventBody userCustomEventBody);

    @HttpRequest(method = HttpMethod.GET, value = "{regId}/user/livechatinfo")
    LivechatContactInformation getLivechatContactInformation(@Path(name = "regId") String regId);
}