All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 26.13.0-beta.1
Show newest version
// Generated by delombok at Tue Sep 03 10:42:51 PDT 2019
// Generated by com.stripe.generator.entity.SdkBuilder
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 SetupIntentCancelParams extends ApiRequestParams {
  /**
   * Reason for canceling this SetupIntent. Possible values are `abandoned`,
   * `requested_by_customer`, or `duplicate`
   */
  @SerializedName("cancellation_reason")
  CancellationReason cancellationReason;
  /**
   * 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;

  private SetupIntentCancelParams(CancellationReason cancellationReason, List expand, Map extraParams) {
    this.cancellationReason = cancellationReason;
    this.expand = expand;
    this.extraParams = extraParams;
  }

  public static Builder builder() {
    return new com.stripe.param.SetupIntentCancelParams.Builder();
  }


  public static class Builder {
    private CancellationReason cancellationReason;
    private List expand;
    private Map extraParams;

    /**
     * Finalize and obtain parameter instance from this builder.
     */
    public SetupIntentCancelParams build() {
      return new SetupIntentCancelParams(this.cancellationReason, this.expand, this.extraParams);
    }

    /**
     * Reason for canceling this SetupIntent. Possible values are `abandoned`,
     * `requested_by_customer`, or `duplicate`
     */
    public Builder setCancellationReason(CancellationReason cancellationReason) {
      this.cancellationReason = cancellationReason;
      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
     * SetupIntentCancelParams#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
     * SetupIntentCancelParams#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
     * SetupIntentCancelParams#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 SetupIntentCancelParams#extraParams} for the field documentation.
     */
    public Builder putAllExtraParam(Map map) {
      if (this.extraParams == null) {
        this.extraParams = new HashMap<>();
      }
      this.extraParams.putAll(map);
      return this;
    }
  }


  public enum CancellationReason implements ApiRequestParams.EnumParam {
    @SerializedName("abandoned")
    ABANDONED("abandoned"), @SerializedName("duplicate")
    DUPLICATE("duplicate"), @SerializedName("requested_by_customer")
    REQUESTED_BY_CUSTOMER("requested_by_customer");
    private final String value;

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy