com.stripe.param.FileLinkCreateParams 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 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 FileLinkCreateParams extends ApiRequestParams {
  /** Specifies which fields in the response should be expanded. */
  @SerializedName("expand")
  List expand;

  /** A future timestamp after which the link will no longer be usable. */
  @SerializedName("expires_at")
  Long expiresAt;

  /**
   * The ID of the file. The file's `purpose` must be one of the following: `business_icon`,
   * `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`,
   * `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`.
   */
  @SerializedName("file")
  String file;

  /**
   * Set of key-value pairs that you can attach to an object. This can be useful for storing
   * additional information about the object in a structured format.
   */
  @SerializedName("metadata")
  Map metadata;

  private FileLinkCreateParams(
      List expand, Long expiresAt, String file, Map metadata) {
    this.expand = expand;
    this.expiresAt = expiresAt;
    this.file = file;
    this.metadata = metadata;
  }

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

  public static class Builder {
    private List expand;

    private Long expiresAt;

    private String file;

    private Map metadata;

    /** Finalize and obtain parameter instance from this builder. */
    public FileLinkCreateParams build() {
      return new FileLinkCreateParams(this.expand, this.expiresAt, this.file, this.metadata);
    }

    /**
     * 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
     * FileLinkCreateParams#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
     * FileLinkCreateParams#expand} for the field documentation.
     */
    public Builder addAllExpand(List elements) {
      if (this.expand == null) {
        this.expand = new ArrayList<>();
      }
      this.expand.addAll(elements);
      return this;
    }

    /** A future timestamp after which the link will no longer be usable. */
    public Builder setExpiresAt(Long expiresAt) {
      this.expiresAt = expiresAt;
      return this;
    }

    /**
     * The ID of the file. The file's `purpose` must be one of the following: `business_icon`,
     * `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`,
     * `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`.
     */
    public Builder setFile(String file) {
      this.file = file;
      return this;
    }

    /**
     * Add a key/value pair to `metadata` 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
     * FileLinkCreateParams#metadata} for the field documentation.
     */
    public Builder putMetadata(String key, String value) {
      if (this.metadata == null) {
        this.metadata = new HashMap<>();
      }
      this.metadata.put(key, value);
      return this;
    }

    /**
     * Add all map key/value pairs to `metadata` 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 FileLinkCreateParams#metadata} for the field documentation.
     */
    public Builder putAllMetadata(Map map) {
      if (this.metadata == null) {
        this.metadata = new HashMap<>();
      }
      this.metadata.putAll(map);
      return this;
    }
  }
}