-
public interface EngagementApiInterface
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classEngagementApiInterface.EngagementRequestAcceptActionpublic classEngagementApiInterface.EngagementRequestDeclineActionpublic classEngagementApiInterface.EngagementEndAction
-
Method Summary
Modifier and Type Method Description abstract Call<Object>acceptEngagementRequest(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementRequestId, @Body() EngagementApiInterface.EngagementRequestAcceptAction acceptAction)Interface method for accepting Engagement Request.Uses retrofit to set headers and required authorizationToken parameter. abstract Call<Object>declineEngagementRequest(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementRequestId, @Body() EngagementApiInterface.EngagementRequestDeclineAction declineAction)Interface method for declining Engagement Request.Uses retrofit to set headers and required authorizationToken parameter. abstract Call<Object>endEngagement(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementId, @Body() EngagementApiInterface.EngagementEndAction endAction)Interface method for ending Engagement.Uses retrofit to set headers and required authorizationToken parameter. abstract Call<EngagementRequestResponse>requestEngagement(@Header(value = Authorization) String authorizationToken, @Body() EngagementRequestBody postBody)Interface method for requesting Engagement with Operator. abstract Call<ResponseBody>cancelEngagementRequest(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_request_id) String requestId, @Body() Map<String, String> body)Interface method for canceling ongoing Engagement Request. abstract Call<ChatMessageResponse>sendChatMessage(@Header(value = Authorization) String authorizationToken, @Body() InternalChatMessage body, @Path(value = engagement_id) String engagementId, @Path(value = id) String messageId)Interface method for sending chat messages. abstract Call<ResponseBody>answerMediaUpgradeRequest(@Header(value = Authorization) String authorizationToken, @Body() MediaUpgradeResponse body, @Path(value = engagement_id) String engagementId, @Path(value = media_upgrade_request_id) String requestId)Interface method for accepting/declining media upgrade request. abstract Call<EngagementFileInternal>uploadFile(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementId, @Part() MultipartBody.Part file)Interface method for uploading files during engagement. abstract Call<ResponseBody>fetchFile(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementId, @Path(value = file_id) String fileId)Interface method for fetching file content. abstract Call<SurveyResponse>fetchSurvey(@NonNull() @Header(value = Authorization) String authorizationToken, @NonNull() @Path(value = engagement_id) String engagementId)Interface method for fetching engagement's survey. -
-
Method Detail
-
acceptEngagementRequest
@Headers(value = {"Accept: application/vnd.salemove.v1+json", "Content-Type: application/json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@PATCH(value = engagement_requests/{engagement_id}) abstract Call<Object> acceptEngagementRequest(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementRequestId, @Body() EngagementApiInterface.EngagementRequestAcceptAction acceptAction)Interface method for accepting Engagement Request.Uses retrofit to set headers and required authorizationToken parameter.
-
declineEngagementRequest
@Headers(value = {"Accept: application/vnd.salemove.v1+json", "Content-Type: application/json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@PATCH(value = engagement_requests/{engagement_id}) abstract Call<Object> declineEngagementRequest(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementRequestId, @Body() EngagementApiInterface.EngagementRequestDeclineAction declineAction)Interface method for declining Engagement Request.Uses retrofit to set headers and required authorizationToken parameter.
-
endEngagement
@Headers(value = {"Accept: application/vnd.salemove.v1+json", "Content-Type: application/json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@PATCH(value = engagements/{engagement_id}) abstract Call<Object> endEngagement(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementId, @Body() EngagementApiInterface.EngagementEndAction endAction)Interface method for ending Engagement.Uses retrofit to set headers and required authorizationToken parameter.
-
requestEngagement
@Headers(value = {"Accept: application/vnd.salemove.v1+json", "Content-Type: application/json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@POST(value = engagement_requests) abstract Call<EngagementRequestResponse> requestEngagement(@Header(value = Authorization) String authorizationToken, @Body() EngagementRequestBody postBody)Interface method for requesting Engagement with Operator.
-
cancelEngagementRequest
@Headers(value = {"Accept: application/vnd.salemove.v1+json", "Content-Type: application/json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@PATCH(value = engagement_requests/{engagement_request_id}) abstract Call<ResponseBody> cancelEngagementRequest(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_request_id) String requestId, @Body() Map<String, String> body)Interface method for canceling ongoing Engagement Request.
-
sendChatMessage
@Headers(value = {"Content-Type: application/json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@PUT(value = engagements/{engagement_id}/chat_messages/{id}) abstract Call<ChatMessageResponse> sendChatMessage(@Header(value = Authorization) String authorizationToken, @Body() InternalChatMessage body, @Path(value = engagement_id) String engagementId, @Path(value = id) String messageId)Interface method for sending chat messages.
-
answerMediaUpgradeRequest
@Headers(value = {"Accept: application/vnd.salemove.v1+json", "Content-Type: application/json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@PATCH(value = engagements/{engagement_id}/media_upgrade_requests/{media_upgrade_request_id}) abstract Call<ResponseBody> answerMediaUpgradeRequest(@Header(value = Authorization) String authorizationToken, @Body() MediaUpgradeResponse body, @Path(value = engagement_id) String engagementId, @Path(value = media_upgrade_request_id) String requestId)Interface method for accepting/declining media upgrade request.
-
uploadFile
@Multipart()@Headers(value = {"Accept: application/vnd.salemove.v1+json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@POST(value = engagements/{engagement_id}/files) abstract Call<EngagementFileInternal> uploadFile(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementId, @Part() MultipartBody.Part file)Interface method for uploading files during engagement.
-
fetchFile
@Headers(value = {"User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME})@GET(value = engagements/{engagement_id}/files/{file_id})@Streaming()@Deprecated() abstract Call<ResponseBody> fetchFile(@Header(value = Authorization) String authorizationToken, @Path(value = engagement_id) String engagementId, @Path(value = file_id) String fileId)Interface method for fetching file content.
-
fetchSurvey
@GET(value = engagements/{engagement_id}/survey)@Headers(value = {"Accept: application/vnd.salemove.v1+json", "Content-Type: application/json", "User-Agent: SaleMove Android SDK " + BuildConfig.VERSION_NAME}) abstract Call<SurveyResponse> fetchSurvey(@NonNull() @Header(value = Authorization) String authorizationToken, @NonNull() @Path(value = engagement_id) String engagementId)Interface method for fetching engagement's survey.
-
-
-
-