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
The newest version!
// File generated from our OpenAPI spec
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;
import lombok.Getter;

@Getter
public class AccountLinkCreateParams extends ApiRequestParams {
  /** Required. The identifier of the account to create an account link for. */
  @SerializedName("account")
  String account;

  /** The collect parameter is deprecated. Use {@code collection_options} instead. */
  @SerializedName("collect")
  Collect collect;

  /**
   * Specifies the requirements that Stripe collects from connected accounts in the Connect
   * Onboarding flow.
   */
  @SerializedName("collection_options")
  CollectionOptions collectionOptions;

  /** 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 the user will be redirected to if the account link is expired, has been
   * previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a
   * new account link with the same parameters used to create the original account link, then
   * redirect the user to the new account link's URL so they can continue with Connect Onboarding.
   * If a new account link cannot be generated or the redirect fails you should display a useful
   * error to the user.
   */
  @SerializedName("refresh_url")
  String refreshUrl;

  /** The URL that the user will be redirected to upon leaving or completing the linked flow. */
  @SerializedName("return_url")
  String returnUrl;

  /**
   * Required. The type of account link the user is requesting. Possible values are
   * {@code account_onboarding} or {@code account_update}.
   */
  @SerializedName("type")
  Type type;

  private AccountLinkCreateParams(
      String account,
      Collect collect,
      CollectionOptions collectionOptions,
      List expand,
      Map extraParams,
      String refreshUrl,
      String returnUrl,
      Type type) {
    this.account = account;
    this.collect = collect;
    this.collectionOptions = collectionOptions;
    this.expand = expand;
    this.extraParams = extraParams;
    this.refreshUrl = refreshUrl;
    this.returnUrl = returnUrl;
    this.type = type;
  }

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

  public static class Builder {
    private String account;

    private Collect collect;

    private CollectionOptions collectionOptions;

    private List expand;

    private Map extraParams;

    private String refreshUrl;

    private String returnUrl;

    private Type type;

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

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

    /** The collect parameter is deprecated. Use {@code collection_options} instead. */
    public Builder setCollect(AccountLinkCreateParams.Collect collect) {
      this.collect = collect;
      return this;
    }

    /**
     * Specifies the requirements that Stripe collects from connected accounts in the Connect
     * Onboarding flow.
     */
    public Builder setCollectionOptions(
        AccountLinkCreateParams.CollectionOptions collectionOptions) {
      this.collectionOptions = collectionOptions;
      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 the user will be redirected to if the account link is expired, has been
     * previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a
     * new account link with the same parameters used to create the original account link, then
     * redirect the user to the new account link's URL so they can continue with Connect Onboarding.
     * If a new account link cannot be generated or the redirect fails you should display a useful
     * error to the user.
     */
    public Builder setRefreshUrl(String refreshUrl) {
      this.refreshUrl = refreshUrl;
      return this;
    }

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

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

  @Getter
  public static class CollectionOptions {
    /**
     * 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;

    /**
     * Specifies whether the platform collects only currently_due requirements ({@code
     * currently_due}) or both currently_due and eventually_due requirements ({@code
     * eventually_due}). If you don't specify {@code collection_options}, the default value is
     * {@code currently_due}.
     */
    @SerializedName("fields")
    Fields fields;

    /**
     * Specifies whether the platform collects future_requirements in addition to requirements in
     * Connect Onboarding. The default value is {@code omit}.
     */
    @SerializedName("future_requirements")
    FutureRequirements futureRequirements;

    private CollectionOptions(
        Map extraParams, Fields fields, FutureRequirements futureRequirements) {
      this.extraParams = extraParams;
      this.fields = fields;
      this.futureRequirements = futureRequirements;
    }

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

    public static class Builder {
      private Map extraParams;

      private Fields fields;

      private FutureRequirements futureRequirements;

      /** Finalize and obtain parameter instance from this builder. */
      public AccountLinkCreateParams.CollectionOptions build() {
        return new AccountLinkCreateParams.CollectionOptions(
            this.extraParams, this.fields, this.futureRequirements);
      }

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

      /**
       * Specifies whether the platform collects only currently_due requirements ({@code
       * currently_due}) or both currently_due and eventually_due requirements ({@code
       * eventually_due}). If you don't specify {@code collection_options}, the default value is
       * {@code currently_due}.
       */
      public Builder setFields(AccountLinkCreateParams.CollectionOptions.Fields fields) {
        this.fields = fields;
        return this;
      }

      /**
       * Specifies whether the platform collects future_requirements in addition to requirements in
       * Connect Onboarding. The default value is {@code omit}.
       */
      public Builder setFutureRequirements(
          AccountLinkCreateParams.CollectionOptions.FutureRequirements futureRequirements) {
        this.futureRequirements = futureRequirements;
        return this;
      }
    }

    public enum Fields implements ApiRequestParams.EnumParam {
      @SerializedName("currently_due")
      CURRENTLY_DUE("currently_due"),

      @SerializedName("eventually_due")
      EVENTUALLY_DUE("eventually_due");

      @Getter(onMethod_ = {@Override})
      private final String value;

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

    public enum FutureRequirements implements ApiRequestParams.EnumParam {
      @SerializedName("include")
      INCLUDE("include"),

      @SerializedName("omit")
      OMIT("omit");

      @Getter(onMethod_ = {@Override})
      private final String value;

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

  public enum Collect implements ApiRequestParams.EnumParam {
    @SerializedName("currently_due")
    CURRENTLY_DUE("currently_due"),

    @SerializedName("eventually_due")
    EVENTUALLY_DUE("eventually_due");

    @Getter(onMethod_ = {@Override})
    private final String value;

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

  public enum Type implements ApiRequestParams.EnumParam {
    @SerializedName("account_onboarding")
    ACCOUNT_ONBOARDING("account_onboarding"),

    @SerializedName("account_update")
    ACCOUNT_UPDATE("account_update");

    @Getter(onMethod_ = {@Override})
    private final String value;

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