io.smooch.v2.client.model.WeChatAllOf 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.2
* 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.JsonPropertyOrder;
/**
* To configure a WeChat integration, browse to the Develop section of the [WeChat dashboard](https://mp.weixin.qq.com/) and add the following IP addresses to the whitelist, separated by new lines. This must be done before calling the Create Integration endpoint. * 34.224.190.28 * 52.6.201.31 * 52.0.232.16 * 34.246.106.80 * 34.246.57.194 From the same page, acquire the WeChat App ID and App Secret from the customer and call the Create Integration endpoint. In their [WeChat dashboard](https://mp.weixin.qq.com/), the customer must set the \"URL\" field to https://app.smooch.io/api/wechat/webhooks/{smoochAppId}/{smoochIntegrationId}, and set the “Token” field to the value of the webhookSecret found in the response to the call to the Create Integration endpoint.
*/
@ApiModel(description = "To configure a WeChat integration, browse to the Develop section of the [WeChat dashboard](https://mp.weixin.qq.com/) and add the following IP addresses to the whitelist, separated by new lines. This must be done before calling the Create Integration endpoint. * 34.224.190.28 * 52.6.201.31 * 52.0.232.16 * 34.246.106.80 * 34.246.57.194 From the same page, acquire the WeChat App ID and App Secret from the customer and call the Create Integration endpoint. In their [WeChat dashboard](https://mp.weixin.qq.com/), the customer must set the \"URL\" field to https://app.smooch.io/api/wechat/webhooks/{smoochAppId}/{smoochIntegrationId}, and set the “Token” field to the value of the webhookSecret found in the response to the call to the Create Integration endpoint. ")
@JsonPropertyOrder({
WeChatAllOf.JSON_PROPERTY_APP_ID,
WeChatAllOf.JSON_PROPERTY_APP_SECRET,
WeChatAllOf.JSON_PROPERTY_ENCODING_AES_KEY
})
public class WeChatAllOf {
public static final String JSON_PROPERTY_APP_ID = "appId";
private String appId;
public static final String JSON_PROPERTY_APP_SECRET = "appSecret";
private Boolean appSecret;
public static final String JSON_PROPERTY_ENCODING_AES_KEY = "encodingAesKey";
private String encodingAesKey = "0099ff";
public WeChatAllOf appId(String appId) {
this.appId = appId;
return this;
}
/**
* WeChat App ID.
* @return appId
**/
@ApiModelProperty(required = true, value = "WeChat App ID.")
@JsonProperty(JSON_PROPERTY_APP_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getAppId() {
return appId;
}
public void setAppId(String appId) {
this.appId = appId;
}
public WeChatAllOf appSecret(Boolean appSecret) {
this.appSecret = appSecret;
return this;
}
/**
* WeChat App Secret.
* @return appSecret
**/
@ApiModelProperty(required = true, value = "WeChat App Secret.")
@JsonProperty(JSON_PROPERTY_APP_SECRET)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Boolean getAppSecret() {
return appSecret;
}
public void setAppSecret(Boolean appSecret) {
this.appSecret = appSecret;
}
public WeChatAllOf encodingAesKey(String encodingAesKey) {
this.encodingAesKey = encodingAesKey;
return this;
}
/**
* AES Encoding Key.
* @return encodingAesKey
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "AES Encoding Key.")
@JsonProperty(JSON_PROPERTY_ENCODING_AES_KEY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEncodingAesKey() {
return encodingAesKey;
}
public void setEncodingAesKey(String encodingAesKey) {
this.encodingAesKey = encodingAesKey;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
WeChatAllOf weChatAllOf = (WeChatAllOf) o;
return Objects.equals(this.appId, weChatAllOf.appId) &&
Objects.equals(this.appSecret, weChatAllOf.appSecret) &&
Objects.equals(this.encodingAesKey, weChatAllOf.encodingAesKey);
}
@Override
public int hashCode() {
return Objects.hash(appId, appSecret, encodingAesKey);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class WeChatAllOf {\n");
sb.append(" appId: ").append(toIndentedString(appId)).append("\n");
sb.append(" appSecret: ").append(toIndentedString(appSecret)).append("\n");
sb.append(" encodingAesKey: ").append(toIndentedString(encodingAesKey)).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 ");
}
}