com.configcat.publicapi.java.client.model.InviteMembersRequest Maven / Gradle / Ivy
/*
* ConfigCat Public Management API
* The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header.
*
* The version of the OpenAPI document: v1
* 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 com.configcat.publicapi.java.client.model;
import com.configcat.publicapi.java.client.JSON;
import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.TypeAdapter;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.annotations.SerializedName;
import com.google.gson.reflect.TypeToken;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
/** InviteMembersRequest */
@javax.annotation.Generated(
value = "org.openapitools.codegen.languages.JavaClientCodegen",
date = "2024-10-09T12:38:06.739118192Z[Etc/UTC]",
comments = "Generator version: 7.7.0")
public class InviteMembersRequest {
public static final String SERIALIZED_NAME_EMAILS = "emails";
@SerializedName(SERIALIZED_NAME_EMAILS)
private List emails = new ArrayList<>();
public static final String SERIALIZED_NAME_PERMISSION_GROUP_ID = "permissionGroupId";
@SerializedName(SERIALIZED_NAME_PERMISSION_GROUP_ID)
private Long permissionGroupId;
public InviteMembersRequest() {}
public InviteMembersRequest emails(List emails) {
this.emails = emails;
return this;
}
public InviteMembersRequest addEmailsItem(String emailsItem) {
if (this.emails == null) {
this.emails = new ArrayList<>();
}
this.emails.add(emailsItem);
return this;
}
/**
* List of email addresses to invite.
*
* @return emails
*/
@javax.annotation.Nonnull
public List getEmails() {
return emails;
}
public void setEmails(List emails) {
this.emails = emails;
}
public InviteMembersRequest permissionGroupId(Long permissionGroupId) {
this.permissionGroupId = permissionGroupId;
return this;
}
/**
* Identifier of the Permission Group to where the invited users should be added.
*
* @return permissionGroupId
*/
@javax.annotation.Nonnull
public Long getPermissionGroupId() {
return permissionGroupId;
}
public void setPermissionGroupId(Long permissionGroupId) {
this.permissionGroupId = permissionGroupId;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
InviteMembersRequest inviteMembersRequest = (InviteMembersRequest) o;
return Objects.equals(this.emails, inviteMembersRequest.emails)
&& Objects.equals(this.permissionGroupId, inviteMembersRequest.permissionGroupId);
}
@Override
public int hashCode() {
return Objects.hash(emails, permissionGroupId);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class InviteMembersRequest {\n");
sb.append(" emails: ").append(toIndentedString(emails)).append("\n");
sb.append(" permissionGroupId: ")
.append(toIndentedString(permissionGroupId))
.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(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("emails");
openapiFields.add("permissionGroupId");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("emails");
openapiRequiredFields.add("permissionGroupId");
}
/**
* Validates the JSON Element and throws an exception if issues found
*
* @param jsonElement JSON Element
* @throws IOException if the JSON Element is invalid with respect to InviteMembersRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!InviteMembersRequest.openapiRequiredFields
.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(
String.format(
"The required field(s) %s in InviteMembersRequest is not found in"
+ " the empty JSON string",
InviteMembersRequest.openapiRequiredFields.toString()));
}
}
Set> entries = jsonElement.getAsJsonObject().entrySet();
// check to see if the JSON string contains additional fields
for (Map.Entry entry : entries) {
if (!InviteMembersRequest.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(
String.format(
"The field `%s` in the JSON string is not defined in the"
+ " `InviteMembersRequest` properties. JSON: %s",
entry.getKey(), jsonElement.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : InviteMembersRequest.openapiRequiredFields) {
if (jsonElement.getAsJsonObject().get(requiredField) == null) {
throw new IllegalArgumentException(
String.format(
"The required field `%s` is not found in the JSON string: %s",
requiredField, jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// ensure the required json array is present
if (jsonObj.get("emails") == null) {
throw new IllegalArgumentException(
"Expected the field `linkedContent` to be an array in the JSON string but got"
+ " `null`");
} else if (!jsonObj.get("emails").isJsonArray()) {
throw new IllegalArgumentException(
String.format(
"Expected the field `emails` to be an array in the JSON string but got"
+ " `%s`",
jsonObj.get("emails").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!InviteMembersRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'InviteMembersRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter =
gson.getDelegateAdapter(this, TypeToken.get(InviteMembersRequest.class));
return (TypeAdapter)
new TypeAdapter() {
@Override
public void write(JsonWriter out, InviteMembersRequest value)
throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public InviteMembersRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
return thisAdapter.fromJsonTree(jsonElement);
}
}.nullSafe();
}
}
/**
* Create an instance of InviteMembersRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of InviteMembersRequest
* @throws IOException if the JSON string is invalid with respect to InviteMembersRequest
*/
public static InviteMembersRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, InviteMembersRequest.class);
}
/**
* Convert an instance of InviteMembersRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy