com.stripe.param.AccountLinkCreateParams Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stripe-java Show documentation
Stripe Java Bindings
There is a newer version: 28.2.0
// Generated by delombok at Fri May 01 10:51:46 PDT 2020
package com.stripe.param;

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;

public class AccountLinkCreateParams extends ApiRequestParams {
  /**
   * The identifier of the account to create an account link for.
   */
  @SerializedName("account")
  String account;
  /**
   * Which information the platform needs to collect from the user. One of {@code currently_due} or
   * {@code eventually_due}. Default is {@code currently_due}.
   */
  @SerializedName("collect")
  Collect collect;
  /**
   * 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;
  /**
   * The URL that the user will be redirected to if the account link is no longer valid.
   */
  @SerializedName("failure_url")
  String failureUrl;
  /**
   * The URL that the user will be redirected to upon leaving or completing the linked flow
   * successfully.
   */
  @SerializedName("success_url")
  String successUrl;
  /**
   * The type of account link the user is requesting. Possible values are {@code
   * custom_account_verification} or {@code custom_account_update}.
   */
  @SerializedName("type")
  Type type;

  private AccountLinkCreateParams(String account, Collect collect, List expand, Map extraParams, String failureUrl, String successUrl, Type type) {
    this.account = account;
    this.collect = collect;
    this.expand = expand;
    this.extraParams = extraParams;
    this.failureUrl = failureUrl;
    this.successUrl = successUrl;
    this.type = type;
  }

  public static Builder builder() {
    return new Builder();
  }


  public static class Builder {
    private String account;
    private Collect collect;
    private List expand;
    private Map extraParams;
    private String failureUrl;
    private String successUrl;
    private Type type;

    /**
     * Finalize and obtain parameter instance from this builder.
     */
    public AccountLinkCreateParams build() {
      return new AccountLinkCreateParams(this.account, this.collect, this.expand, this.extraParams, this.failureUrl, this.successUrl, this.type);
    }

    /**
     * The identifier of the account to create an account link for.
     */
    public Builder setAccount(String account) {
      this.account = account;
      return this;
    }

    /**
     * Which information the platform needs to collect from the user. One of {@code currently_due}
     * or {@code eventually_due}. Default is {@code currently_due}.
     */
    public Builder setCollect(Collect collect) {
      this.collect = collect;
      return this;
    }

    /**
     * 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
     * AccountLinkCreateParams#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
     * AccountLinkCreateParams#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
     * AccountLinkCreateParams#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 AccountLinkCreateParams#extraParams} for the field documentation.
     */
    public Builder putAllExtraParam(Map map) {
      if (this.extraParams == null) {
        this.extraParams = new HashMap<>();
      }
      this.extraParams.putAll(map);
      return this;
    }

    /**
     * The URL that the user will be redirected to if the account link is no longer valid.
     */
    public Builder setFailureUrl(String failureUrl) {
      this.failureUrl = failureUrl;
      return this;
    }

    /**
     * The URL that the user will be redirected to upon leaving or completing the linked flow
     * successfully.
     */
    public Builder setSuccessUrl(String successUrl) {
      this.successUrl = successUrl;
      return this;
    }

    /**
     * The type of account link the user is requesting. Possible values are {@code
     * custom_account_verification} or {@code custom_account_update}.
     */
    public Builder setType(Type type) {
      this.type = type;
      return this;
    }
  }


  public enum Collect implements ApiRequestParams.EnumParam {
    @SerializedName("currently_due")
    CURRENTLY_DUE("currently_due"), @SerializedName("eventually_due")
    EVENTUALLY_DUE("eventually_due");
    private final String value;

    Collect(String value) {
      this.value = value;
    }

    @Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getValue() {
      return this.value;
    }
  }


  public enum Type implements ApiRequestParams.EnumParam {
    @SerializedName("custom_account_update")
    CUSTOM_ACCOUNT_UPDATE("custom_account_update"), @SerializedName("custom_account_verification")
    CUSTOM_ACCOUNT_VERIFICATION("custom_account_verification");
    private final String value;

    Type(String value) {
      this.value = value;
    }

    @Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getValue() {
      return this.value;
    }
  }

  /**
   * The identifier of the account to create an account link for.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public String getAccount() {
    return this.account;
  }

  /**
   * Which information the platform needs to collect from the user. One of {@code currently_due} or
   * {@code eventually_due}. Default is {@code currently_due}.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public Collect getCollect() {
    return this.collect;
  }

  /**
   * Specifies which fields in the response should be expanded.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public List getExpand() {
    return this.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.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public Map getExtraParams() {
    return this.extraParams;
  }

  /**
   * The URL that the user will be redirected to if the account link is no longer valid.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public String getFailureUrl() {
    return this.failureUrl;
  }

  /**
   * The URL that the user will be redirected to upon leaving or completing the linked flow
   * successfully.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public String getSuccessUrl() {
    return this.successUrl;
  }

  /**
   * The type of account link the user is requesting. Possible values are {@code
   * custom_account_verification} or {@code custom_account_update}.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public Type getType() {
    return this.type;
  }
}