com.twilio.rest.conversations.v1.service.ConversationUpdater Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Show all versions of twilio Show documentation
Twilio Java Helper Library
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.conversations.v1.service;
import com.twilio.base.Updater;
import com.twilio.converter.DateConverter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
import java.time.ZonedDateTime;
public class ConversationUpdater extends Updater {
private final String pathChatServiceSid;
private final String pathSid;
private String friendlyName;
private ZonedDateTime dateCreated;
private ZonedDateTime dateUpdated;
private String attributes;
private String messagingServiceSid;
private Conversation.State state;
private String timersInactive;
private String timersClosed;
private Conversation.WebhookEnabledType xTwilioWebhookEnabled;
/**
* Construct a new ConversationUpdater.
*
* @param pathChatServiceSid The chat_service_sid
* @param pathSid A 34 character string that uniquely identifies this resource.
*/
public ConversationUpdater(final String pathChatServiceSid,
final String pathSid) {
this.pathChatServiceSid = pathChatServiceSid;
this.pathSid = pathSid;
}
/**
* The human-readable name of this conversation, limited to 256 characters.
* Optional..
*
* @param friendlyName The human-readable name of this conversation.
* @return this
*/
public ConversationUpdater setFriendlyName(final String friendlyName) {
this.friendlyName = friendlyName;
return this;
}
/**
* The date that this resource was created..
*
* @param dateCreated The date that this resource was created.
* @return this
*/
public ConversationUpdater setDateCreated(final ZonedDateTime dateCreated) {
this.dateCreated = dateCreated;
return this;
}
/**
* The date that this resource was last updated..
*
* @param dateUpdated The date that this resource was last updated.
* @return this
*/
public ConversationUpdater setDateUpdated(final ZonedDateTime dateUpdated) {
this.dateUpdated = dateUpdated;
return this;
}
/**
* An optional string metadata field you can use to store any data you wish. The
* string value must contain structurally valid JSON if specified. **Note**
* that if the attributes are not set "{}" will be returned..
*
* @param attributes An optional string metadata field you can use to store any
* data you wish.
* @return this
*/
public ConversationUpdater setAttributes(final String attributes) {
this.attributes = attributes;
return this;
}
/**
* The unique ID of the Messaging Service
* this conversation belongs to..
*
* @param messagingServiceSid The unique ID of the Messaging Service this
* conversation belongs to.
* @return this
*/
public ConversationUpdater setMessagingServiceSid(final String messagingServiceSid) {
this.messagingServiceSid = messagingServiceSid;
return this;
}
/**
* Current state of this conversation. Can be either `active`, `inactive` or
* `closed` and defaults to `active`.
*
* @param state Current state of this conversation.
* @return this
*/
public ConversationUpdater setState(final Conversation.State state) {
this.state = state;
return this;
}
/**
* ISO8601 duration when conversation will be switched to `inactive` state.
* Minimum value for this timer is 1 minute..
*
* @param timersInactive ISO8601 duration when conversation will be switched to
* `inactive` state.
* @return this
*/
public ConversationUpdater setTimersInactive(final String timersInactive) {
this.timersInactive = timersInactive;
return this;
}
/**
* ISO8601 duration when conversation will be switched to `closed` state.
* Minimum value for this timer is 10 minutes..
*
* @param timersClosed ISO8601 duration when conversation will be switched to
* `closed` state.
* @return this
*/
public ConversationUpdater setTimersClosed(final String timersClosed) {
this.timersClosed = timersClosed;
return this;
}
/**
* The X-Twilio-Webhook-Enabled HTTP request header.
*
* @param xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP request header
* @return this
*/
public ConversationUpdater setXTwilioWebhookEnabled(final Conversation.WebhookEnabledType xTwilioWebhookEnabled) {
this.xTwilioWebhookEnabled = xTwilioWebhookEnabled;
return this;
}
/**
* Make the request to the Twilio API to perform the update.
*
* @param client TwilioRestClient with which to make the request
* @return Updated Conversation
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Conversation update(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.POST,
Domains.CONVERSATIONS.toString(),
"/v1/Services/" + this.pathChatServiceSid + "/Conversations/" + this.pathSid + ""
);
addPostParams(request);
addHeaderParams(request);
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("Conversation update failed: Unable to connect to server");
} else if (!TwilioRestClient.SUCCESS.test(response.getStatusCode())) {
RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
if (restException == null) {
throw new ApiException("Server Error, no content");
}
throw new ApiException(restException);
}
return Conversation.fromJson(response.getStream(), client.getObjectMapper());
}
/**
* Add the requested header parameters to the Request.
*
* @param request Request to add header params to
*/
private void addHeaderParams(final Request request) {
if (xTwilioWebhookEnabled != null) {
request.addHeaderParam("X-Twilio-Webhook-Enabled", xTwilioWebhookEnabled.toString());
}
}
/**
* Add the requested post parameters to the Request.
*
* @param request Request to add post params to
*/
private void addPostParams(final Request request) {
if (friendlyName != null) {
request.addPostParam("FriendlyName", friendlyName);
}
if (dateCreated != null) {
request.addPostParam("DateCreated", dateCreated.toString());
}
if (dateUpdated != null) {
request.addPostParam("DateUpdated", dateUpdated.toString());
}
if (attributes != null) {
request.addPostParam("Attributes", attributes);
}
if (messagingServiceSid != null) {
request.addPostParam("MessagingServiceSid", messagingServiceSid);
}
if (state != null) {
request.addPostParam("State", state.toString());
}
if (timersInactive != null) {
request.addPostParam("Timers.Inactive", timersInactive);
}
if (timersClosed != null) {
request.addPostParam("Timers.Closed", timersClosed);
}
}
}