io.smooch.v2.client.model.WhatsappAllOf Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
Show all versions of api Show documentation
io.smooch - api - 6.0.0-alpha.7
/*
* Sunshine Conversations API
* # # Introduction Welcome to the Sunshine Conversations API. The API allows you to craft entirely unique messaging experiences for your app and website as well as talk to any backend or external service. The Sunshine Conversations API is designed according to REST principles. The API accepts JSON in request bodies and requires that the content-type: application/json header be specified for all such requests. The API will always respond with an object. Depending on context, resources may be returned as single objects or as arrays of objects, nested within the response object. In some cases, the API will also facilitate cross-origin resource sharing so that it can be called from a web application. ## API pagination and records limits Some APIs can be paginated by providing the `offset` query string parameter. The `offset` is the number of initial records to skip before picking records to return (default 0). The `limit` query string can also be provided to change the number of records to return (maximum 100, default 25). All paginated endpoints will eventually support cursor pagination and `offset` based pagination support will be dropped. ### Cursor Pagination Some APIs are paginated through cursor pagination. Rather than providing an `offset`, a `page[after]` or `page[before]` query string parameter may be provided. `page[after]` and `page[before]` are cursors pointing to a record id. The `page[after]` cursor indicates that only records **subsequent** to it should be returned. The `page[before]` cursor indicates that only records **preceding** it should be returned. **Only one** of `page[after]` or `page[before]` may be provided in a query, not both. In cursor pagination, the equivalent to the `limit` query string is the `page[size]` query string parameter. ## Regions Sunshine Conversations is available in the following regions. Each Sunshine Conversations region has its own API host. | Region | Host | | -------------- | -------------------------- | | United States | https://api.smooch.io | | European Union | https://api.eu-1.smooch.io | For more information on regions, visit [the guide](/guide/regions/).
*
* The version of the OpenAPI document: 6.0.0-alpha.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package io.smooch.v2.client.model;
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.openapitools.jackson.nullable.JsonNullable;
import java.util.NoSuchElementException;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
/**
* To configure a WhatsApp integration, use your WhatsApp API Client connection information. Sunshine Conversations can provide WhatsApp API Client hosting for approved brands. See our [WhatsApp guide](https://docs.smooch.io/guide/whatsapp/#whatsapp-api-client) for more details on WhatsApp API Client hosting.
*/
@ApiModel(description = "To configure a WhatsApp integration, use your WhatsApp API Client connection information. Sunshine Conversations can provide WhatsApp API Client hosting for approved brands. See our [WhatsApp guide](https://docs.smooch.io/guide/whatsapp/#whatsapp-api-client) for more details on WhatsApp API Client hosting. ")
@JsonPropertyOrder({
WhatsappAllOf.JSON_PROPERTY_DEPLOYMENT_ID,
WhatsappAllOf.JSON_PROPERTY_HSM_FALLBACK_LANGUAGE,
WhatsappAllOf.JSON_PROPERTY_ACCOUNT_ID,
WhatsappAllOf.JSON_PROPERTY_ACCOUNT_MANAGEMENT_ACCESS_TOKEN
})
public class WhatsappAllOf {
public static final String JSON_PROPERTY_DEPLOYMENT_ID = "deploymentId";
private String deploymentId;
public static final String JSON_PROPERTY_HSM_FALLBACK_LANGUAGE = "hsmFallbackLanguage";
private JsonNullable hsmFallbackLanguage = JsonNullable.undefined();
public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
private JsonNullable accountId = JsonNullable.undefined();
public static final String JSON_PROPERTY_ACCOUNT_MANAGEMENT_ACCESS_TOKEN = "accountManagementAccessToken";
private JsonNullable accountManagementAccessToken = JsonNullable.undefined();
public WhatsappAllOf deploymentId(String deploymentId) {
this.deploymentId = deploymentId;
return this;
}
/**
* The Id of the deployment. The integrationId and the appId will be added to the deployment. Additionally, the deployment’s status will be set to integrated.
* @return deploymentId
**/
@ApiModelProperty(required = true, value = "The Id of the deployment. The integrationId and the appId will be added to the deployment. Additionally, the deployment’s status will be set to integrated.")
@JsonProperty(JSON_PROPERTY_DEPLOYMENT_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getDeploymentId() {
return deploymentId;
}
public void setDeploymentId(String deploymentId) {
this.deploymentId = deploymentId;
}
public WhatsappAllOf hsmFallbackLanguage(String hsmFallbackLanguage) {
this.hsmFallbackLanguage = JsonNullable.of(hsmFallbackLanguage);
return this;
}
/**
* Specify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info.
* @return hsmFallbackLanguage
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Specify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info.")
@JsonIgnore
public String getHsmFallbackLanguage() {
return hsmFallbackLanguage.orElse(null);
}
@JsonProperty(JSON_PROPERTY_HSM_FALLBACK_LANGUAGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getHsmFallbackLanguage_JsonNullable() {
return hsmFallbackLanguage;
}
@JsonProperty(JSON_PROPERTY_HSM_FALLBACK_LANGUAGE)
public void setHsmFallbackLanguage_JsonNullable(JsonNullable hsmFallbackLanguage) {
this.hsmFallbackLanguage = hsmFallbackLanguage;
}
public void setHsmFallbackLanguage(String hsmFallbackLanguage) {
this.hsmFallbackLanguage = JsonNullable.of(hsmFallbackLanguage);
}
public WhatsappAllOf accountId(String accountId) {
this.accountId = JsonNullable.of(accountId);
return this;
}
/**
* The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction.
* @return accountId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction.")
@JsonIgnore
public String getAccountId() {
return accountId.orElse(null);
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getAccountId_JsonNullable() {
return accountId;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
public void setAccountId_JsonNullable(JsonNullable accountId) {
this.accountId = accountId;
}
public void setAccountId(String accountId) {
this.accountId = JsonNullable.of(accountId);
}
public WhatsappAllOf accountManagementAccessToken(String accountManagementAccessToken) {
this.accountManagementAccessToken = JsonNullable.of(accountManagementAccessToken);
return this;
}
/**
* An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction.
* @return accountManagementAccessToken
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction.")
@JsonIgnore
public String getAccountManagementAccessToken() {
return accountManagementAccessToken.orElse(null);
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_MANAGEMENT_ACCESS_TOKEN)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getAccountManagementAccessToken_JsonNullable() {
return accountManagementAccessToken;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_MANAGEMENT_ACCESS_TOKEN)
public void setAccountManagementAccessToken_JsonNullable(JsonNullable accountManagementAccessToken) {
this.accountManagementAccessToken = accountManagementAccessToken;
}
public void setAccountManagementAccessToken(String accountManagementAccessToken) {
this.accountManagementAccessToken = JsonNullable.of(accountManagementAccessToken);
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
WhatsappAllOf whatsappAllOf = (WhatsappAllOf) o;
return Objects.equals(this.deploymentId, whatsappAllOf.deploymentId) &&
Objects.equals(this.hsmFallbackLanguage, whatsappAllOf.hsmFallbackLanguage) &&
Objects.equals(this.accountId, whatsappAllOf.accountId) &&
Objects.equals(this.accountManagementAccessToken, whatsappAllOf.accountManagementAccessToken);
}
@Override
public int hashCode() {
return Objects.hash(deploymentId, hsmFallbackLanguage, accountId, accountManagementAccessToken);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class WhatsappAllOf {\n");
sb.append(" deploymentId: ").append(toIndentedString(deploymentId)).append("\n");
sb.append(" hsmFallbackLanguage: ").append(toIndentedString(hsmFallbackLanguage)).append("\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" accountManagementAccessToken: ").append(toIndentedString(accountManagementAccessToken)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}