io.smooch.v2.client.model.LineAllOf 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.JsonPropertyOrder;
/**
* For LINE, each of your customers will need to manually configure a webhook in their LINE configuration page that will point to Sunshine Conversations servers. You must instruct your customers how to configure this manually on their LINE bot page. Once you’ve acquired all the required information, call the Create Integration endpoint. Then, using the returned integration _id, your customer must set the Callback URL field in their LINE Business Center page. The URL should look like the following: `https://app.smooch.io:443/api/line/webhooks/{appId}/{integrationId}`.
*/
@ApiModel(description = "For LINE, each of your customers will need to manually configure a webhook in their LINE configuration page that will point to Sunshine Conversations servers. You must instruct your customers how to configure this manually on their LINE bot page. Once you’ve acquired all the required information, call the Create Integration endpoint. Then, using the returned integration _id, your customer must set the Callback URL field in their LINE Business Center page. The URL should look like the following: `https://app.smooch.io:443/api/line/webhooks/{appId}/{integrationId}`. ")
@JsonPropertyOrder({
LineAllOf.JSON_PROPERTY_CHANNEL_ID,
LineAllOf.JSON_PROPERTY_CHANNEL_SECRET,
LineAllOf.JSON_PROPERTY_CHANNEL_ACCESS_TOKEN,
LineAllOf.JSON_PROPERTY_SERVICE_CODE,
LineAllOf.JSON_PROPERTY_SWITCHER_SECRET,
LineAllOf.JSON_PROPERTY_QR_CODE_URL,
LineAllOf.JSON_PROPERTY_LINE_ID
})
public class LineAllOf {
public static final String JSON_PROPERTY_CHANNEL_ID = "channelId";
private String channelId;
public static final String JSON_PROPERTY_CHANNEL_SECRET = "channelSecret";
private String channelSecret;
public static final String JSON_PROPERTY_CHANNEL_ACCESS_TOKEN = "channelAccessToken";
private String channelAccessToken;
public static final String JSON_PROPERTY_SERVICE_CODE = "serviceCode";
private String serviceCode;
public static final String JSON_PROPERTY_SWITCHER_SECRET = "switcherSecret";
private String switcherSecret;
public static final String JSON_PROPERTY_QR_CODE_URL = "qrCodeUrl";
private String qrCodeUrl;
public static final String JSON_PROPERTY_LINE_ID = "lineId";
private String lineId;
public LineAllOf channelId(String channelId) {
this.channelId = channelId;
return this;
}
/**
* LINE Channel ID.
* @return channelId
**/
@ApiModelProperty(required = true, value = "LINE Channel ID.")
@JsonProperty(JSON_PROPERTY_CHANNEL_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getChannelId() {
return channelId;
}
public void setChannelId(String channelId) {
this.channelId = channelId;
}
public LineAllOf channelSecret(String channelSecret) {
this.channelSecret = channelSecret;
return this;
}
/**
* LINE Channel Secret.
* @return channelSecret
**/
@ApiModelProperty(required = true, value = "LINE Channel Secret.")
@JsonProperty(JSON_PROPERTY_CHANNEL_SECRET)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getChannelSecret() {
return channelSecret;
}
public void setChannelSecret(String channelSecret) {
this.channelSecret = channelSecret;
}
public LineAllOf channelAccessToken(String channelAccessToken) {
this.channelAccessToken = channelAccessToken;
return this;
}
/**
* LINE Channel Access Token.
* @return channelAccessToken
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "LINE Channel Access Token.")
@JsonProperty(JSON_PROPERTY_CHANNEL_ACCESS_TOKEN)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getChannelAccessToken() {
return channelAccessToken;
}
public void setChannelAccessToken(String channelAccessToken) {
this.channelAccessToken = channelAccessToken;
}
public LineAllOf serviceCode(String serviceCode) {
this.serviceCode = serviceCode;
return this;
}
/**
* LINE Service Code.
* @return serviceCode
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "LINE Service Code.")
@JsonProperty(JSON_PROPERTY_SERVICE_CODE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getServiceCode() {
return serviceCode;
}
public void setServiceCode(String serviceCode) {
this.serviceCode = serviceCode;
}
public LineAllOf switcherSecret(String switcherSecret) {
this.switcherSecret = switcherSecret;
return this;
}
/**
* LINE Switcher Secret.
* @return switcherSecret
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "LINE Switcher Secret.")
@JsonProperty(JSON_PROPERTY_SWITCHER_SECRET)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSwitcherSecret() {
return switcherSecret;
}
public void setSwitcherSecret(String switcherSecret) {
this.switcherSecret = switcherSecret;
}
public LineAllOf qrCodeUrl(String qrCodeUrl) {
this.qrCodeUrl = qrCodeUrl;
return this;
}
/**
* URL provided by LINE in the [Developer Console](https://developers.line.biz/console/).
* @return qrCodeUrl
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "URL provided by LINE in the [Developer Console](https://developers.line.biz/console/).")
@JsonProperty(JSON_PROPERTY_QR_CODE_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getQrCodeUrl() {
return qrCodeUrl;
}
public void setQrCodeUrl(String qrCodeUrl) {
this.qrCodeUrl = qrCodeUrl;
}
/**
* LINE Basic ID. Is automatically set when qrCodeUrl is updated.
* @return lineId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "LINE Basic ID. Is automatically set when qrCodeUrl is updated.")
@JsonProperty(JSON_PROPERTY_LINE_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getLineId() {
return lineId;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
LineAllOf lineAllOf = (LineAllOf) o;
return Objects.equals(this.channelId, lineAllOf.channelId) &&
Objects.equals(this.channelSecret, lineAllOf.channelSecret) &&
Objects.equals(this.channelAccessToken, lineAllOf.channelAccessToken) &&
Objects.equals(this.serviceCode, lineAllOf.serviceCode) &&
Objects.equals(this.switcherSecret, lineAllOf.switcherSecret) &&
Objects.equals(this.qrCodeUrl, lineAllOf.qrCodeUrl) &&
Objects.equals(this.lineId, lineAllOf.lineId);
}
@Override
public int hashCode() {
return Objects.hash(channelId, channelSecret, channelAccessToken, serviceCode, switcherSecret, qrCodeUrl, lineId);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class LineAllOf {\n");
sb.append(" channelId: ").append(toIndentedString(channelId)).append("\n");
sb.append(" channelSecret: ").append(toIndentedString(channelSecret)).append("\n");
sb.append(" channelAccessToken: ").append(toIndentedString(channelAccessToken)).append("\n");
sb.append(" serviceCode: ").append(toIndentedString(serviceCode)).append("\n");
sb.append(" switcherSecret: ").append(toIndentedString(switcherSecret)).append("\n");
sb.append(" qrCodeUrl: ").append(toIndentedString(qrCodeUrl)).append("\n");
sb.append(" lineId: ").append(toIndentedString(lineId)).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 ");
}
}