io.smooch.v2.client.model.MatchCriteria 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;
/**
* The set of criteria used to determine the user's identity on a third-party channel.
*/
@ApiModel(description = "The set of criteria used to determine the user's identity on a third-party channel.")
@JsonPropertyOrder({
MatchCriteria.JSON_PROPERTY_TYPE,
MatchCriteria.JSON_PROPERTY_INTEGRATION_ID,
MatchCriteria.JSON_PROPERTY_PHONE_NUMBER,
MatchCriteria.JSON_PROPERTY_ADDRESS,
MatchCriteria.JSON_PROPERTY_SUBJECT,
MatchCriteria.JSON_PROPERTY_PRIMARY
})
public class MatchCriteria {
/**
* The channel type.
*/
public enum TypeEnum {
TWILIO("twilio"),
MESSAGEBIRD("messagebird"),
WHATSAPP("whatsapp"),
MAILGUN("mailgun");
private String value;
TypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_TYPE = "type";
private TypeEnum type;
public static final String JSON_PROPERTY_INTEGRATION_ID = "integrationId";
private String integrationId;
public static final String JSON_PROPERTY_PHONE_NUMBER = "phoneNumber";
private String phoneNumber;
public static final String JSON_PROPERTY_ADDRESS = "address";
private String address;
public static final String JSON_PROPERTY_SUBJECT = "subject";
private String subject = "New message from {appName}";
public static final String JSON_PROPERTY_PRIMARY = "primary";
private Boolean primary = true;
public MatchCriteria type(TypeEnum type) {
this.type = type;
return this;
}
/**
* The channel type.
* @return type
**/
@ApiModelProperty(required = true, value = "The channel type.")
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public TypeEnum getType() {
return type;
}
public void setType(TypeEnum type) {
this.type = type;
}
public MatchCriteria integrationId(String integrationId) {
this.integrationId = integrationId;
return this;
}
/**
* The ID of the integration to link. Must match the provided type.
* @return integrationId
**/
@ApiModelProperty(required = true, value = "The ID of the integration to link. Must match the provided type.")
@JsonProperty(JSON_PROPERTY_INTEGRATION_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getIntegrationId() {
return integrationId;
}
public void setIntegrationId(String integrationId) {
this.integrationId = integrationId;
}
public MatchCriteria phoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
return this;
}
/**
* The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. Applies to `twilio`, `messagebird` and `whatsapp` integrations.
* @return phoneNumber
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368. Applies to `twilio`, `messagebird` and `whatsapp` integrations. ")
@JsonProperty(JSON_PROPERTY_PHONE_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPhoneNumber() {
return phoneNumber;
}
public void setPhoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
}
public MatchCriteria address(String address) {
this.address = address;
return this;
}
/**
* The user’s email address. Applies to the `mailgun` integration.
* @return address
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The user’s email address. Applies to the `mailgun` integration.")
@JsonProperty(JSON_PROPERTY_ADDRESS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public MatchCriteria subject(String subject) {
this.subject = subject;
return this;
}
/**
* May be specified to set the subject for the outgoing email. Only applicable with mailgun.
* @return subject
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "May be specified to set the subject for the outgoing email. Only applicable with mailgun.")
@JsonProperty(JSON_PROPERTY_SUBJECT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSubject() {
return subject;
}
public void setSubject(String subject) {
this.subject = subject;
}
public MatchCriteria primary(Boolean primary) {
this.primary = primary;
return this;
}
/**
* Flag indicating whether the client will become the primary for the target conversation once linking is complete.
* @return primary
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Flag indicating whether the client will become the primary for the target conversation once linking is complete.")
@JsonProperty(JSON_PROPERTY_PRIMARY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getPrimary() {
return primary;
}
public void setPrimary(Boolean primary) {
this.primary = primary;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
MatchCriteria matchCriteria = (MatchCriteria) o;
return Objects.equals(this.type, matchCriteria.type) &&
Objects.equals(this.integrationId, matchCriteria.integrationId) &&
Objects.equals(this.phoneNumber, matchCriteria.phoneNumber) &&
Objects.equals(this.address, matchCriteria.address) &&
Objects.equals(this.subject, matchCriteria.subject) &&
Objects.equals(this.primary, matchCriteria.primary);
}
@Override
public int hashCode() {
return Objects.hash(type, integrationId, phoneNumber, address, subject, primary);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class MatchCriteria {\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" integrationId: ").append(toIndentedString(integrationId)).append("\n");
sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n");
sb.append(" address: ").append(toIndentedString(address)).append("\n");
sb.append(" subject: ").append(toIndentedString(subject)).append("\n");
sb.append(" primary: ").append(toIndentedString(primary)).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 ");
}
}