com.unblu.webapi.jersey.v3.api.BotsApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey3-client-v3 Show documentation
Show all versions of jersey3-client-v3 Show documentation
Client implemented using Jersey
package com.unblu.webapi.jersey.v3.api;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import jakarta.ws.rs.core.GenericType;
import com.unblu.webapi.jersey.v3.invoker.ApiClient;
import com.unblu.webapi.jersey.v3.invoker.ApiException;
import com.unblu.webapi.jersey.v3.invoker.ApiResponse;
import com.unblu.webapi.jersey.v3.invoker.Configuration;
import com.unblu.webapi.jersey.v3.invoker.Pair;
import com.unblu.webapi.model.v3.BotDialogPostMessage;
import com.unblu.webapi.model.v3.BotPostMessage;
import com.unblu.webapi.model.v3.BotsAcceptDialogOfferBody;
import com.unblu.webapi.model.v3.BotsCancelDialogBotTypingIndicatorBody;
import com.unblu.webapi.model.v3.BotsCancelPendingDialogQuestionsBody;
import com.unblu.webapi.model.v3.BotsCancelPendingQuestionBody;
import com.unblu.webapi.model.v3.BotsDeclineDialogOfferBody;
import com.unblu.webapi.model.v3.BotsDialogMessageDeliveredBody;
import com.unblu.webapi.model.v3.BotsDialogMessageReadBody;
import com.unblu.webapi.model.v3.BotsFinishDialogBody;
import com.unblu.webapi.model.v3.BotsPingWebhookBody;
import com.unblu.webapi.model.v3.BotsRestrictDialogCounterpartBody;
import com.unblu.webapi.model.v3.BotsStartDialogBotTypingIndicatorBody;
import com.unblu.webapi.model.v3.DialogBotData;
import com.unblu.webapi.model.v3.DialogBotQuery;
import com.unblu.webapi.model.v3.DialogBotResult;
import com.unblu.webapi.model.v3.EBotDialogFinishReason;
public class BotsApi {
private ApiClient apiClient;
public BotsApi() {
this(Configuration.getDefaultApiClient());
}
public BotsApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* acceptDialogOffer Accepts a dialog offer that was triggered either via a `BotOnboardingOfferEvent`, `BotReboardingOfferEvent` or a
* `BotOffboardingOfferEvent`webhook. <p> Accepting the dialog offer will result in the dialog bot participating in the offered dialog. As soon
* as it is the dialogs turn it will receive a`BotDialogOpenEvent` webhook.<br>
*
* @param botsAcceptDialogOfferBody (required)
* @return String
* @throws ApiException if fails to make API call
*/
public String botsAcceptDialogOffer(BotsAcceptDialogOfferBody botsAcceptDialogOfferBody) throws ApiException {
return botsAcceptDialogOfferWithHttpInfo(botsAcceptDialogOfferBody).getData();
}
/**
* acceptDialogOffer Accepts a dialog offer that was triggered either via a `BotOnboardingOfferEvent`, `BotReboardingOfferEvent` or a
* `BotOffboardingOfferEvent`webhook. <p> Accepting the dialog offer will result in the dialog bot participating in the offered dialog. As soon
* as it is the dialogs turn it will receive a`BotDialogOpenEvent` webhook.<br>
*
* @param botsAcceptDialogOfferBody (required)
* @return ApiResponse<String>
* @throws ApiException if fails to make API call
*/
public ApiResponse botsAcceptDialogOfferWithHttpInfo(BotsAcceptDialogOfferBody botsAcceptDialogOfferBody) throws ApiException {
Object localVarPostBody = botsAcceptDialogOfferBody;
// verify the required parameter 'botsAcceptDialogOfferBody' is set
if (botsAcceptDialogOfferBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsAcceptDialogOfferBody' when calling botsAcceptDialogOffer");
}
// create path and map variables
String localVarPath = "/bots/acceptDialogOffer";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* acceptDialogOffer Accepts a dialog offer that was triggered either via a `BotOnboardingOfferEvent`, `BotReboardingOfferEvent` or a
* `BotOffboardingOfferEvent`webhook. <p> Accepting the dialog offer will result in the dialog bot participating in the offered dialog. As soon
* as it is the dialogs turn it will receive a`BotDialogOpenEvent` webhook.<br>
*
* @param dialogOfferToken (optional)
* @return String
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public String botsAcceptDialogOfferLegacyGet(String dialogOfferToken) throws ApiException {
return botsAcceptDialogOfferLegacyGetWithHttpInfo(dialogOfferToken).getData();
}
/**
* acceptDialogOffer Accepts a dialog offer that was triggered either via a `BotOnboardingOfferEvent`, `BotReboardingOfferEvent` or a
* `BotOffboardingOfferEvent`webhook. <p> Accepting the dialog offer will result in the dialog bot participating in the offered dialog. As soon
* as it is the dialogs turn it will receive a`BotDialogOpenEvent` webhook.<br>
*
* @param dialogOfferToken (optional)
* @return ApiResponse<String>
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public ApiResponse botsAcceptDialogOfferLegacyGetWithHttpInfo(String dialogOfferToken) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/acceptDialogOffer";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "dialogOfferToken", dialogOfferToken));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* cancelDialogBotTypingIndicator Hides the typing indicator for the dialog bot.<br> If the typing indicator wasn't displayed, calling the endpoint
* has no effect.<br>
*
* @param botsCancelDialogBotTypingIndicatorBody (required)
* @throws ApiException if fails to make API call
*/
public void botsCancelDialogBotTypingIndicator(BotsCancelDialogBotTypingIndicatorBody botsCancelDialogBotTypingIndicatorBody) throws ApiException {
botsCancelDialogBotTypingIndicatorWithHttpInfo(botsCancelDialogBotTypingIndicatorBody);
}
/**
* cancelDialogBotTypingIndicator Hides the typing indicator for the dialog bot.<br> If the typing indicator wasn't displayed, calling the endpoint
* has no effect.<br>
*
* @param botsCancelDialogBotTypingIndicatorBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsCancelDialogBotTypingIndicatorWithHttpInfo(BotsCancelDialogBotTypingIndicatorBody botsCancelDialogBotTypingIndicatorBody) throws ApiException {
Object localVarPostBody = botsCancelDialogBotTypingIndicatorBody;
// verify the required parameter 'botsCancelDialogBotTypingIndicatorBody' is set
if (botsCancelDialogBotTypingIndicatorBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsCancelDialogBotTypingIndicatorBody' when calling botsCancelDialogBotTypingIndicator");
}
// create path and map variables
String localVarPath = "/bots/cancelDialogBotTypingIndicator";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* cancelPendingDialogQuestions Cancels all pending questions in a bot dialog.<br>
*
* @param botsCancelPendingDialogQuestionsBody (required)
* @throws ApiException if fails to make API call
*/
public void botsCancelPendingDialogQuestions(BotsCancelPendingDialogQuestionsBody botsCancelPendingDialogQuestionsBody) throws ApiException {
botsCancelPendingDialogQuestionsWithHttpInfo(botsCancelPendingDialogQuestionsBody);
}
/**
* cancelPendingDialogQuestions Cancels all pending questions in a bot dialog.<br>
*
* @param botsCancelPendingDialogQuestionsBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsCancelPendingDialogQuestionsWithHttpInfo(BotsCancelPendingDialogQuestionsBody botsCancelPendingDialogQuestionsBody) throws ApiException {
Object localVarPostBody = botsCancelPendingDialogQuestionsBody;
// verify the required parameter 'botsCancelPendingDialogQuestionsBody' is set
if (botsCancelPendingDialogQuestionsBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsCancelPendingDialogQuestionsBody' when calling botsCancelPendingDialogQuestions");
}
// create path and map variables
String localVarPath = "/bots/cancelPendingDialogQuestions";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* cancelPendingQuestion Cancels a bot's question message. If the message is not from a bot, the call will throw an error.<br>
*
* @param botsCancelPendingQuestionBody (required)
* @throws ApiException if fails to make API call
*/
public void botsCancelPendingQuestion(BotsCancelPendingQuestionBody botsCancelPendingQuestionBody) throws ApiException {
botsCancelPendingQuestionWithHttpInfo(botsCancelPendingQuestionBody);
}
/**
* cancelPendingQuestion Cancels a bot's question message. If the message is not from a bot, the call will throw an error.<br>
*
* @param botsCancelPendingQuestionBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsCancelPendingQuestionWithHttpInfo(BotsCancelPendingQuestionBody botsCancelPendingQuestionBody) throws ApiException {
Object localVarPostBody = botsCancelPendingQuestionBody;
// verify the required parameter 'botsCancelPendingQuestionBody' is set
if (botsCancelPendingQuestionBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsCancelPendingQuestionBody' when calling botsCancelPendingQuestion");
}
// create path and map variables
String localVarPath = "/bots/cancelPendingQuestion";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* create Creates a new dialog bot that can be used for conversation onboarding, reboarding and offboarding.<br>
*
* @param dialogBotData The dialog bot to create. (required)
* @return DialogBotData
* @throws ApiException if fails to make API call
*/
public DialogBotData botsCreate(DialogBotData dialogBotData) throws ApiException {
return botsCreateWithHttpInfo(dialogBotData).getData();
}
/**
* create Creates a new dialog bot that can be used for conversation onboarding, reboarding and offboarding.<br>
*
* @param dialogBotData The dialog bot to create. (required)
* @return ApiResponse<DialogBotData>
* @throws ApiException if fails to make API call
*/
public ApiResponse botsCreateWithHttpInfo(DialogBotData dialogBotData) throws ApiException {
Object localVarPostBody = dialogBotData;
// verify the required parameter 'dialogBotData' is set
if (dialogBotData == null) {
throw new ApiException(400, "Missing the required parameter 'dialogBotData' when calling botsCreate");
}
// create path and map variables
String localVarPath = "/bots/create";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* declineDialogOffer Declines a dialog offer that was triggered either via a `BotOnboardingOfferEvent`, `BotReboardingOfferEvent` or
* a`BotOffboardingOfferEvent` webhook. <p> No further webhooks will be sent for this dialog.<br>
*
* @param botsDeclineDialogOfferBody (required)
* @throws ApiException if fails to make API call
*/
public void botsDeclineDialogOffer(BotsDeclineDialogOfferBody botsDeclineDialogOfferBody) throws ApiException {
botsDeclineDialogOfferWithHttpInfo(botsDeclineDialogOfferBody);
}
/**
* declineDialogOffer Declines a dialog offer that was triggered either via a `BotOnboardingOfferEvent`, `BotReboardingOfferEvent` or
* a`BotOffboardingOfferEvent` webhook. <p> No further webhooks will be sent for this dialog.<br>
*
* @param botsDeclineDialogOfferBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsDeclineDialogOfferWithHttpInfo(BotsDeclineDialogOfferBody botsDeclineDialogOfferBody) throws ApiException {
Object localVarPostBody = botsDeclineDialogOfferBody;
// verify the required parameter 'botsDeclineDialogOfferBody' is set
if (botsDeclineDialogOfferBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsDeclineDialogOfferBody' when calling botsDeclineDialogOffer");
}
// create path and map variables
String localVarPath = "/bots/declineDialogOffer";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* declineDialogOffer Declines a dialog offer that was triggered either via a `BotOnboardingOfferEvent`, `BotReboardingOfferEvent` or
* a`BotOffboardingOfferEvent` webhook. <p> No further webhooks will be sent for this dialog.<br>
*
* @param dialogOfferToken (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public void botsDeclineDialogOfferLegacyGet(String dialogOfferToken) throws ApiException {
botsDeclineDialogOfferLegacyGetWithHttpInfo(dialogOfferToken);
}
/**
* declineDialogOffer Declines a dialog offer that was triggered either via a `BotOnboardingOfferEvent`, `BotReboardingOfferEvent` or
* a`BotOffboardingOfferEvent` webhook. <p> No further webhooks will be sent for this dialog.<br>
*
* @param dialogOfferToken (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public ApiResponse botsDeclineDialogOfferLegacyGetWithHttpInfo(String dialogOfferToken) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/declineDialogOffer";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "dialogOfferToken", dialogOfferToken));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* delete Deletes an existing dialog bot<br>
*
* @param id The ID of the dialog bot which should be deleted (optional)
* @throws ApiException if fails to make API call
*/
public void botsDelete(String id) throws ApiException {
botsDeleteWithHttpInfo(id);
}
/**
* delete Deletes an existing dialog bot<br>
*
* @param id The ID of the dialog bot which should be deleted (optional)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsDeleteWithHttpInfo(String id) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/delete";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "id", id));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "DELETE", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* delete Deletes an existing dialog bot<br>
*
* @param id The ID of the dialog bot which should be deleted (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public void botsDeleteLegacyGet(String id) throws ApiException {
botsDeleteLegacyGetWithHttpInfo(id);
}
/**
* delete Deletes an existing dialog bot<br>
*
* @param id The ID of the dialog bot which should be deleted (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public ApiResponse botsDeleteLegacyGetWithHttpInfo(String id) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/delete";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "id", id));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* dialogMessageDelivered Marks a message as delivered to the bot.<br> <br> <b>Note:</b> If the message is also read use the
* `dialogMessageRead` end point directly as it will also mark the message as delivered.<br>
*
* @param botsDialogMessageDeliveredBody (required)
* @throws ApiException if fails to make API call
*/
public void botsDialogMessageDelivered(BotsDialogMessageDeliveredBody botsDialogMessageDeliveredBody) throws ApiException {
botsDialogMessageDeliveredWithHttpInfo(botsDialogMessageDeliveredBody);
}
/**
* dialogMessageDelivered Marks a message as delivered to the bot.<br> <br> <b>Note:</b> If the message is also read use the
* `dialogMessageRead` end point directly as it will also mark the message as delivered.<br>
*
* @param botsDialogMessageDeliveredBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsDialogMessageDeliveredWithHttpInfo(BotsDialogMessageDeliveredBody botsDialogMessageDeliveredBody) throws ApiException {
Object localVarPostBody = botsDialogMessageDeliveredBody;
// verify the required parameter 'botsDialogMessageDeliveredBody' is set
if (botsDialogMessageDeliveredBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsDialogMessageDeliveredBody' when calling botsDialogMessageDelivered");
}
// create path and map variables
String localVarPath = "/bots/dialogMessageDelivered";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* dialogMessageDelivered Marks a message as delivered to the bot.<br> <br> <b>Note:</b> If the message is also read use the
* `dialogMessageRead` end point directly as it will also mark the message as delivered.<br>
*
* @param dialogToken (optional)
* @param messageId (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public void botsDialogMessageDeliveredLegacyGet(String dialogToken, String messageId) throws ApiException {
botsDialogMessageDeliveredLegacyGetWithHttpInfo(dialogToken, messageId);
}
/**
* dialogMessageDelivered Marks a message as delivered to the bot.<br> <br> <b>Note:</b> If the message is also read use the
* `dialogMessageRead` end point directly as it will also mark the message as delivered.<br>
*
* @param dialogToken (optional)
* @param messageId (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public ApiResponse botsDialogMessageDeliveredLegacyGetWithHttpInfo(String dialogToken, String messageId) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/dialogMessageDelivered";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "dialogToken", dialogToken));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "messageId", messageId));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* dialogMessageRead Marks a message as read to the bot.<br> <br> <b>Note:</b> This will also mark the message as delivered, if this
* hasn't happened yet.<br>
*
* @param botsDialogMessageReadBody (required)
* @throws ApiException if fails to make API call
*/
public void botsDialogMessageRead(BotsDialogMessageReadBody botsDialogMessageReadBody) throws ApiException {
botsDialogMessageReadWithHttpInfo(botsDialogMessageReadBody);
}
/**
* dialogMessageRead Marks a message as read to the bot.<br> <br> <b>Note:</b> This will also mark the message as delivered, if this
* hasn't happened yet.<br>
*
* @param botsDialogMessageReadBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsDialogMessageReadWithHttpInfo(BotsDialogMessageReadBody botsDialogMessageReadBody) throws ApiException {
Object localVarPostBody = botsDialogMessageReadBody;
// verify the required parameter 'botsDialogMessageReadBody' is set
if (botsDialogMessageReadBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsDialogMessageReadBody' when calling botsDialogMessageRead");
}
// create path and map variables
String localVarPath = "/bots/dialogMessageRead";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* dialogMessageRead Marks a message as read to the bot.<br> <br> <b>Note:</b> This will also mark the message as delivered, if this
* hasn't happened yet.<br>
*
* @param dialogToken (optional)
* @param messageId (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public void botsDialogMessageReadLegacyGet(String dialogToken, String messageId) throws ApiException {
botsDialogMessageReadLegacyGetWithHttpInfo(dialogToken, messageId);
}
/**
* dialogMessageRead Marks a message as read to the bot.<br> <br> <b>Note:</b> This will also mark the message as delivered, if this
* hasn't happened yet.<br>
*
* @param dialogToken (optional)
* @param messageId (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public ApiResponse botsDialogMessageReadLegacyGetWithHttpInfo(String dialogToken, String messageId) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/dialogMessageRead";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "dialogToken", dialogToken));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "messageId", messageId));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* finishDialog Ends the dialog. Depending on the reason given and whether the dialog takes place during onboarding, reboarding, or offboarding, this will have
* specific effects. See the list below. <p> <b>Reason: `EBotDialogFinishReason.HAND_OFF`:</b><br> <ul>
* <li><b>Onboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the onboarding.
* <li><b>Activate Participation:</b> If no further bots are in the queue the participation is activated. For inbound requests this is the
* point where the conversation is added to the queue. For PIN conversation and invitations the person is simply placed into the conversation and can actively
* participate. </ul> <li><b>Reboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the reboarding.
* <li><b>Requeue Conversation:</b> If no further bots are in the queue the conversation is put back into the queue. </ul>
* <li><b>Offboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the offboarding. <li><b>End
* Participation:</b> If no further bots are in the queue the participation is ended and the offboarding person can no longer access it. </ul>
* </ul> <b>Reason: `EBotDialogFinishReason.SOLVED`:</b><br> <ul> <li><b>Onboarding:</b> <ul>
* <li><b>Unassign Conversation:</b> The conversation will be put in unassigned state and therefore will not be added to the queue as the
* problem is solved. New messages to the conversation will start reboarding. </ul> <b>Reboarding:</b> <ul> <li><b>Unassign
* Conversation:</b> The conversation will be put in unassigned state and therefore will not be added to the queue as the problem is solved. New messages
* to the conversation will start reboarding again. </ul> <b>Offboarding:</b> <ul> <li><b>End Participation:</b>
* Independent if there are further bots in the queue the participation is ended and the offboarding person can no longer access it. </ul> </ul>
* <b>Reason: `EBotDialogFinishReason.ABORTED`:</b><br> <ul> <li><b>Onboarding:</b> <ul>
* <li><b>Offboard Participant:</b> The participant is directly moved to the offboarding phase and won't be allowed to enter the
* conversation. </ul> <b>Reboarding:</b> <ul> <li><b>Unassign Conversation:</b> The participant is directly moved to
* the offboarding phase and won't be allowed to enter the conversation. </ul> <b>Offboarding:</b> <ul> <li><b>End
* Participation:</b> Independent if there are further bots in the queue the participation is ended and the offboarding person can no longer access the
* conversation. </ul> </ul><br>
*
* @param botsFinishDialogBody (required)
* @throws ApiException if fails to make API call
*/
public void botsFinishDialog(BotsFinishDialogBody botsFinishDialogBody) throws ApiException {
botsFinishDialogWithHttpInfo(botsFinishDialogBody);
}
/**
* finishDialog Ends the dialog. Depending on the reason given and whether the dialog takes place during onboarding, reboarding, or offboarding, this will have
* specific effects. See the list below. <p> <b>Reason: `EBotDialogFinishReason.HAND_OFF`:</b><br> <ul>
* <li><b>Onboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the onboarding.
* <li><b>Activate Participation:</b> If no further bots are in the queue the participation is activated. For inbound requests this is the
* point where the conversation is added to the queue. For PIN conversation and invitations the person is simply placed into the conversation and can actively
* participate. </ul> <li><b>Reboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the reboarding.
* <li><b>Requeue Conversation:</b> If no further bots are in the queue the conversation is put back into the queue. </ul>
* <li><b>Offboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the offboarding. <li><b>End
* Participation:</b> If no further bots are in the queue the participation is ended and the offboarding person can no longer access it. </ul>
* </ul> <b>Reason: `EBotDialogFinishReason.SOLVED`:</b><br> <ul> <li><b>Onboarding:</b> <ul>
* <li><b>Unassign Conversation:</b> The conversation will be put in unassigned state and therefore will not be added to the queue as the
* problem is solved. New messages to the conversation will start reboarding. </ul> <b>Reboarding:</b> <ul> <li><b>Unassign
* Conversation:</b> The conversation will be put in unassigned state and therefore will not be added to the queue as the problem is solved. New messages
* to the conversation will start reboarding again. </ul> <b>Offboarding:</b> <ul> <li><b>End Participation:</b>
* Independent if there are further bots in the queue the participation is ended and the offboarding person can no longer access it. </ul> </ul>
* <b>Reason: `EBotDialogFinishReason.ABORTED`:</b><br> <ul> <li><b>Onboarding:</b> <ul>
* <li><b>Offboard Participant:</b> The participant is directly moved to the offboarding phase and won't be allowed to enter the
* conversation. </ul> <b>Reboarding:</b> <ul> <li><b>Unassign Conversation:</b> The participant is directly moved to
* the offboarding phase and won't be allowed to enter the conversation. </ul> <b>Offboarding:</b> <ul> <li><b>End
* Participation:</b> Independent if there are further bots in the queue the participation is ended and the offboarding person can no longer access the
* conversation. </ul> </ul><br>
*
* @param botsFinishDialogBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsFinishDialogWithHttpInfo(BotsFinishDialogBody botsFinishDialogBody) throws ApiException {
Object localVarPostBody = botsFinishDialogBody;
// verify the required parameter 'botsFinishDialogBody' is set
if (botsFinishDialogBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsFinishDialogBody' when calling botsFinishDialog");
}
// create path and map variables
String localVarPath = "/bots/finishDialog";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* finishDialog Ends the dialog. Depending on the reason given and whether the dialog takes place during onboarding, reboarding, or offboarding, this will have
* specific effects. See the list below. <p> <b>Reason: `EBotDialogFinishReason.HAND_OFF`:</b><br> <ul>
* <li><b>Onboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the onboarding.
* <li><b>Activate Participation:</b> If no further bots are in the queue the participation is activated. For inbound requests this is the
* point where the conversation is added to the queue. For PIN conversation and invitations the person is simply placed into the conversation and can actively
* participate. </ul> <li><b>Reboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the reboarding.
* <li><b>Requeue Conversation:</b> If no further bots are in the queue the conversation is put back into the queue. </ul>
* <li><b>Offboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the offboarding. <li><b>End
* Participation:</b> If no further bots are in the queue the participation is ended and the offboarding person can no longer access it. </ul>
* </ul> <b>Reason: `EBotDialogFinishReason.SOLVED`:</b><br> <ul> <li><b>Onboarding:</b> <ul>
* <li><b>Unassign Conversation:</b> The conversation will be put in unassigned state and therefore will not be added to the queue as the
* problem is solved. New messages to the conversation will start reboarding. </ul> <b>Reboarding:</b> <ul> <li><b>Unassign
* Conversation:</b> The conversation will be put in unassigned state and therefore will not be added to the queue as the problem is solved. New messages
* to the conversation will start reboarding again. </ul> <b>Offboarding:</b> <ul> <li><b>End Participation:</b>
* Independent if there are further bots in the queue the participation is ended and the offboarding person can no longer access it. </ul> </ul>
* <b>Reason: `EBotDialogFinishReason.ABORTED`:</b><br> <ul> <li><b>Onboarding:</b> <ul>
* <li><b>Offboard Participant:</b> The participant is directly moved to the offboarding phase and won't be allowed to enter the
* conversation. </ul> <b>Reboarding:</b> <ul> <li><b>Unassign Conversation:</b> The participant is directly moved to
* the offboarding phase and won't be allowed to enter the conversation. </ul> <b>Offboarding:</b> <ul> <li><b>End
* Participation:</b> Independent if there are further bots in the queue the participation is ended and the offboarding person can no longer access the
* conversation. </ul> </ul><br>
*
* @param dialogToken (optional)
* @param reason (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public void botsFinishDialogLegacyGet(String dialogToken, EBotDialogFinishReason reason) throws ApiException {
botsFinishDialogLegacyGetWithHttpInfo(dialogToken, reason);
}
/**
* finishDialog Ends the dialog. Depending on the reason given and whether the dialog takes place during onboarding, reboarding, or offboarding, this will have
* specific effects. See the list below. <p> <b>Reason: `EBotDialogFinishReason.HAND_OFF`:</b><br> <ul>
* <li><b>Onboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the onboarding.
* <li><b>Activate Participation:</b> If no further bots are in the queue the participation is activated. For inbound requests this is the
* point where the conversation is added to the queue. For PIN conversation and invitations the person is simply placed into the conversation and can actively
* participate. </ul> <li><b>Reboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the reboarding.
* <li><b>Requeue Conversation:</b> If no further bots are in the queue the conversation is put back into the queue. </ul>
* <li><b>Offboarding:</b> <ul> <li><b>Next Bot:</b> a further bot takes over the offboarding. <li><b>End
* Participation:</b> If no further bots are in the queue the participation is ended and the offboarding person can no longer access it. </ul>
* </ul> <b>Reason: `EBotDialogFinishReason.SOLVED`:</b><br> <ul> <li><b>Onboarding:</b> <ul>
* <li><b>Unassign Conversation:</b> The conversation will be put in unassigned state and therefore will not be added to the queue as the
* problem is solved. New messages to the conversation will start reboarding. </ul> <b>Reboarding:</b> <ul> <li><b>Unassign
* Conversation:</b> The conversation will be put in unassigned state and therefore will not be added to the queue as the problem is solved. New messages
* to the conversation will start reboarding again. </ul> <b>Offboarding:</b> <ul> <li><b>End Participation:</b>
* Independent if there are further bots in the queue the participation is ended and the offboarding person can no longer access it. </ul> </ul>
* <b>Reason: `EBotDialogFinishReason.ABORTED`:</b><br> <ul> <li><b>Onboarding:</b> <ul>
* <li><b>Offboard Participant:</b> The participant is directly moved to the offboarding phase and won't be allowed to enter the
* conversation. </ul> <b>Reboarding:</b> <ul> <li><b>Unassign Conversation:</b> The participant is directly moved to
* the offboarding phase and won't be allowed to enter the conversation. </ul> <b>Offboarding:</b> <ul> <li><b>End
* Participation:</b> Independent if there are further bots in the queue the participation is ended and the offboarding person can no longer access the
* conversation. </ul> </ul><br>
*
* @param dialogToken (optional)
* @param reason (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public ApiResponse botsFinishDialogLegacyGetWithHttpInfo(String dialogToken, EBotDialogFinishReason reason) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/finishDialog";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "dialogToken", dialogToken));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "reason", reason));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* getByName Searches for an existing dialog bot with the given name.<br>
*
* @param name Name of the dialog bot. (optional)
* @return DialogBotData
* @throws ApiException if fails to make API call
*/
public DialogBotData botsGetByName(String name) throws ApiException {
return botsGetByNameWithHttpInfo(name).getData();
}
/**
* getByName Searches for an existing dialog bot with the given name.<br>
*
* @param name Name of the dialog bot. (optional)
* @return ApiResponse<DialogBotData>
* @throws ApiException if fails to make API call
*/
public ApiResponse botsGetByNameWithHttpInfo(String name) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/getByName";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "name", name));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* pingWebhook Emits a `WebhookPingEvent` on the configured webhook for the dialog bot.<br>
*
* @param botsPingWebhookBody (required)
* @throws ApiException if fails to make API call
*/
public void botsPingWebhook(BotsPingWebhookBody botsPingWebhookBody) throws ApiException {
botsPingWebhookWithHttpInfo(botsPingWebhookBody);
}
/**
* pingWebhook Emits a `WebhookPingEvent` on the configured webhook for the dialog bot.<br>
*
* @param botsPingWebhookBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsPingWebhookWithHttpInfo(BotsPingWebhookBody botsPingWebhookBody) throws ApiException {
Object localVarPostBody = botsPingWebhookBody;
// verify the required parameter 'botsPingWebhookBody' is set
if (botsPingWebhookBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsPingWebhookBody' when calling botsPingWebhook");
}
// create path and map variables
String localVarPath = "/bots/pingWebhook";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* pingWebhook Emits a `WebhookPingEvent` on the configured webhook for the dialog bot.<br>
*
* @param dialogBotId (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public void botsPingWebhookLegacyGet(String dialogBotId) throws ApiException {
botsPingWebhookLegacyGetWithHttpInfo(dialogBotId);
}
/**
* pingWebhook Emits a `WebhookPingEvent` on the configured webhook for the dialog bot.<br>
*
* @param dialogBotId (optional)
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public ApiResponse botsPingWebhookLegacyGetWithHttpInfo(String dialogBotId) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/pingWebhook";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "dialogBotId", dialogBotId));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* read Reads an existing dialog bot.<br>
*
* @param id The ID of the dialog bot. (optional)
* @return DialogBotData
* @throws ApiException if fails to make API call
*/
public DialogBotData botsRead(String id) throws ApiException {
return botsReadWithHttpInfo(id).getData();
}
/**
* read Reads an existing dialog bot.<br>
*
* @param id The ID of the dialog bot. (optional)
* @return ApiResponse<DialogBotData>
* @throws ApiException if fails to make API call
*/
public ApiResponse botsReadWithHttpInfo(String id) throws ApiException {
Object localVarPostBody = new HashMap<>();
// create path and map variables
String localVarPath = "/bots/read";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "id", id));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* restrictDialogCounterpart Limits the length of a message the counterpart can send to the bot in a dialog. <p> The value is reset automatically when the
* bot hands off the dialog.<br>
*
* @param botsRestrictDialogCounterpartBody (required)
* @throws ApiException if fails to make API call
*/
public void botsRestrictDialogCounterpart(BotsRestrictDialogCounterpartBody botsRestrictDialogCounterpartBody) throws ApiException {
botsRestrictDialogCounterpartWithHttpInfo(botsRestrictDialogCounterpartBody);
}
/**
* restrictDialogCounterpart Limits the length of a message the counterpart can send to the bot in a dialog. <p> The value is reset automatically when the
* bot hands off the dialog.<br>
*
* @param botsRestrictDialogCounterpartBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsRestrictDialogCounterpartWithHttpInfo(BotsRestrictDialogCounterpartBody botsRestrictDialogCounterpartBody) throws ApiException {
Object localVarPostBody = botsRestrictDialogCounterpartBody;
// verify the required parameter 'botsRestrictDialogCounterpartBody' is set
if (botsRestrictDialogCounterpartBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsRestrictDialogCounterpartBody' when calling botsRestrictDialogCounterpart");
}
// create path and map variables
String localVarPath = "/bots/restrictDialogCounterpart";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* search Search for dialog bots in the current account<br>
*
* @param dialogBotQuery (required)
* @return DialogBotResult
* @throws ApiException if fails to make API call
*/
public DialogBotResult botsSearch(DialogBotQuery dialogBotQuery) throws ApiException {
return botsSearchWithHttpInfo(dialogBotQuery).getData();
}
/**
* search Search for dialog bots in the current account<br>
*
* @param dialogBotQuery (required)
* @return ApiResponse<DialogBotResult>
* @throws ApiException if fails to make API call
*/
public ApiResponse botsSearchWithHttpInfo(DialogBotQuery dialogBotQuery) throws ApiException {
Object localVarPostBody = dialogBotQuery;
// verify the required parameter 'dialogBotQuery' is set
if (dialogBotQuery == null) {
throw new ApiException(400, "Missing the required parameter 'dialogBotQuery' when calling botsSearch");
}
// create path and map variables
String localVarPath = "/bots/search";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* sendDialogMessage Sends a message as a bot into an ongoing dialog. <p> It can only be used after the bot received the `BotDialogOpenEvent`
* webhook for this dialog.<br>
*
* @param botDialogPostMessage The message to send (required)
* @return String
* @throws ApiException if fails to make API call
*/
public String botsSendDialogMessage(BotDialogPostMessage botDialogPostMessage) throws ApiException {
return botsSendDialogMessageWithHttpInfo(botDialogPostMessage).getData();
}
/**
* sendDialogMessage Sends a message as a bot into an ongoing dialog. <p> It can only be used after the bot received the `BotDialogOpenEvent`
* webhook for this dialog.<br>
*
* @param botDialogPostMessage The message to send (required)
* @return ApiResponse<String>
* @throws ApiException if fails to make API call
*/
public ApiResponse botsSendDialogMessageWithHttpInfo(BotDialogPostMessage botDialogPostMessage) throws ApiException {
Object localVarPostBody = botDialogPostMessage;
// verify the required parameter 'botDialogPostMessage' is set
if (botDialogPostMessage == null) {
throw new ApiException(400, "Missing the required parameter 'botDialogPostMessage' when calling botsSendDialogMessage");
}
// create path and map variables
String localVarPath = "/bots/sendDialogMessage";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* sendMessage Sends a message to a conversation as a bot. <p> This can be used at any time during a conversation. It is not related to bot
* dialogs.<br>
*
* @param botPostMessage The message to send (required)
* @return String
* @throws ApiException if fails to make API call
*/
public String botsSendMessage(BotPostMessage botPostMessage) throws ApiException {
return botsSendMessageWithHttpInfo(botPostMessage).getData();
}
/**
* sendMessage Sends a message to a conversation as a bot. <p> This can be used at any time during a conversation. It is not related to bot
* dialogs.<br>
*
* @param botPostMessage The message to send (required)
* @return ApiResponse<String>
* @throws ApiException if fails to make API call
*/
public ApiResponse botsSendMessageWithHttpInfo(BotPostMessage botPostMessage) throws ApiException {
Object localVarPostBody = botPostMessage;
// verify the required parameter 'botPostMessage' is set
if (botPostMessage == null) {
throw new ApiException(400, "Missing the required parameter 'botPostMessage' when calling botsSendMessage");
}
// create path and map variables
String localVarPath = "/bots/sendMessage";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* startDialogBotTypingIndicator Displays a typing indicator for the dialog bot, to show the counterpart person that something is happening.<br> The
* typing indicator is removed automatically after four seconds or when the bot sends a message, whichever occurs sooner. If the typing indicator is already
* displayed, calling this endpoint resets the four second timer.<br>
*
* @param botsStartDialogBotTypingIndicatorBody (required)
* @throws ApiException if fails to make API call
*/
public void botsStartDialogBotTypingIndicator(BotsStartDialogBotTypingIndicatorBody botsStartDialogBotTypingIndicatorBody) throws ApiException {
botsStartDialogBotTypingIndicatorWithHttpInfo(botsStartDialogBotTypingIndicatorBody);
}
/**
* startDialogBotTypingIndicator Displays a typing indicator for the dialog bot, to show the counterpart person that something is happening.<br> The
* typing indicator is removed automatically after four seconds or when the bot sends a message, whichever occurs sooner. If the typing indicator is already
* displayed, calling this endpoint resets the four second timer.<br>
*
* @param botsStartDialogBotTypingIndicatorBody (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse botsStartDialogBotTypingIndicatorWithHttpInfo(BotsStartDialogBotTypingIndicatorBody botsStartDialogBotTypingIndicatorBody) throws ApiException {
Object localVarPostBody = botsStartDialogBotTypingIndicatorBody;
// verify the required parameter 'botsStartDialogBotTypingIndicatorBody' is set
if (botsStartDialogBotTypingIndicatorBody == null) {
throw new ApiException(400, "Missing the required parameter 'botsStartDialogBotTypingIndicatorBody' when calling botsStartDialogBotTypingIndicator");
}
// create path and map variables
String localVarPath = "/bots/startDialogBotTypingIndicator";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* update Updates an existing dialog bot.<br>
*
* @param dialogBotData (required)
* @return DialogBotData
* @throws ApiException if fails to make API call
*/
public DialogBotData botsUpdate(DialogBotData dialogBotData) throws ApiException {
return botsUpdateWithHttpInfo(dialogBotData).getData();
}
/**
* update Updates an existing dialog bot.<br>
*
* @param dialogBotData (required)
* @return ApiResponse<DialogBotData>
* @throws ApiException if fails to make API call
*/
public ApiResponse botsUpdateWithHttpInfo(DialogBotData dialogBotData) throws ApiException {
Object localVarPostBody = dialogBotData;
// verify the required parameter 'dialogBotData' is set
if (dialogBotData == null) {
throw new ApiException(400, "Missing the required parameter 'dialogBotData' when calling botsUpdate");
}
// create path and map variables
String localVarPath = "/bots/update";
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
GenericType localVarReturnType = new GenericType() {
};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
}