com.stripe.param.apps.SecretDeleteWhereParams Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.param.apps;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class SecretDeleteWhereParams extends ApiRequestParams {
/** Specifies which fields in the response should be expanded. */
@SerializedName("expand")
List expand;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** Required. A name for the secret that's unique within the scope. */
@SerializedName("name")
String name;
/**
* Required. Specifies the scoping of the secret. Requests originating from UI
* extensions can only access account-scoped secrets or secrets scoped to their own user.
*/
@SerializedName("scope")
Scope scope;
private SecretDeleteWhereParams(
List expand, Map extraParams, String name, Scope scope) {
this.expand = expand;
this.extraParams = extraParams;
this.name = name;
this.scope = scope;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private List expand;
private Map extraParams;
private String name;
private Scope scope;
/** Finalize and obtain parameter instance from this builder. */
public SecretDeleteWhereParams build() {
return new SecretDeleteWhereParams(this.expand, this.extraParams, this.name, this.scope);
}
/**
* Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* SecretDeleteWhereParams#expand} for the field documentation.
*/
public Builder addExpand(String element) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.add(element);
return this;
}
/**
* Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* SecretDeleteWhereParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* SecretDeleteWhereParams#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link SecretDeleteWhereParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. A name for the secret that's unique within the scope. */
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* Required. Specifies the scoping of the secret. Requests originating from UI
* extensions can only access account-scoped secrets or secrets scoped to their own user.
*/
public Builder setScope(SecretDeleteWhereParams.Scope scope) {
this.scope = scope;
return this;
}
}
@Getter
public static class Scope {
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** Required. The secret scope type. */
@SerializedName("type")
Type type;
/**
* The user ID. This field is required if {@code type} is set to {@code user}, and should not be
* provided if {@code type} is set to {@code account}.
*/
@SerializedName("user")
String user;
private Scope(Map extraParams, Type type, String user) {
this.extraParams = extraParams;
this.type = type;
this.user = user;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Type type;
private String user;
/** Finalize and obtain parameter instance from this builder. */
public SecretDeleteWhereParams.Scope build() {
return new SecretDeleteWhereParams.Scope(this.extraParams, this.type, this.user);
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* SecretDeleteWhereParams.Scope#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link SecretDeleteWhereParams.Scope#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. The secret scope type. */
public Builder setType(SecretDeleteWhereParams.Scope.Type type) {
this.type = type;
return this;
}
/**
* The user ID. This field is required if {@code type} is set to {@code user}, and should not
* be provided if {@code type} is set to {@code account}.
*/
public Builder setUser(String user) {
this.user = user;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("account")
ACCOUNT("account"),
@SerializedName("user")
USER("user");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}