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

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

There is a newer version: 28.1.0-beta.3
Show newest version
// File generated from our OpenAPI spec
package com.stripe.param;

import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.param.common.EmptyParam;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;

@Getter
public class TaxRateUpdateParams extends ApiRequestParams {
  /**
   * Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates
   * cannot be used with new applications or Checkout Sessions, but will still work for
   * subscriptions and invoices that already have it set.
   */
  @SerializedName("active")
  Boolean active;

  /**
   * Two-letter country code (ISO 3166-1
   * alpha-2).
   */
  @SerializedName("country")
  Object country;

  /**
   * An arbitrary string attached to the tax rate for your internal use only. It will not be visible
   * to your customers.
   */
  @SerializedName("description")
  Object description;

  /** The display name of the tax rate, which will be shown to users. */
  @SerializedName("display_name")
  Object displayName;

  /** 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 jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It
   * also appears on your customer’s invoice.
   */
  @SerializedName("jurisdiction")
  Object jurisdiction;

  /**
   * 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. Individual keys can be unset by posting an empty value to them. All keys can
   * be unset by posting an empty value to {@code metadata}.
   */
  @SerializedName("metadata")
  Object metadata;

  /**
   * ISO 3166-2 subdivision code, without
   * country prefix. For example, "NY" for New York, United States.
   */
  @SerializedName("state")
  Object state;

  /** The high-level tax type, such as {@code vat} or {@code sales_tax}. */
  @SerializedName("tax_type")
  TaxType taxType;

  private TaxRateUpdateParams(
      Boolean active,
      Object country,
      Object description,
      Object displayName,
      List expand,
      Map extraParams,
      Object jurisdiction,
      Object metadata,
      Object state,
      TaxType taxType) {
    this.active = active;
    this.country = country;
    this.description = description;
    this.displayName = displayName;
    this.expand = expand;
    this.extraParams = extraParams;
    this.jurisdiction = jurisdiction;
    this.metadata = metadata;
    this.state = state;
    this.taxType = taxType;
  }

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

  public static class Builder {
    private Boolean active;

    private Object country;

    private Object description;

    private Object displayName;

    private List expand;

    private Map extraParams;

    private Object jurisdiction;

    private Object metadata;

    private Object state;

    private TaxType taxType;

    /** Finalize and obtain parameter instance from this builder. */
    public TaxRateUpdateParams build() {
      return new TaxRateUpdateParams(
          this.active,
          this.country,
          this.description,
          this.displayName,
          this.expand,
          this.extraParams,
          this.jurisdiction,
          this.metadata,
          this.state,
          this.taxType);
    }

    /**
     * Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates
     * cannot be used with new applications or Checkout Sessions, but will still work for
     * subscriptions and invoices that already have it set.
     */
    public Builder setActive(Boolean active) {
      this.active = active;
      return this;
    }

    /**
     * Two-letter country code (ISO
     * 3166-1 alpha-2).
     */
    public Builder setCountry(String country) {
      this.country = country;
      return this;
    }

    /**
     * Two-letter country code (ISO
     * 3166-1 alpha-2).
     */
    public Builder setCountry(EmptyParam country) {
      this.country = country;
      return this;
    }

    /**
     * An arbitrary string attached to the tax rate for your internal use only. It will not be
     * visible to your customers.
     */
    public Builder setDescription(String description) {
      this.description = description;
      return this;
    }

    /**
     * An arbitrary string attached to the tax rate for your internal use only. It will not be
     * visible to your customers.
     */
    public Builder setDescription(EmptyParam description) {
      this.description = description;
      return this;
    }

    /** The display name of the tax rate, which will be shown to users. */
    public Builder setDisplayName(String displayName) {
      this.displayName = displayName;
      return this;
    }

    /** The display name of the tax rate, which will be shown to users. */
    public Builder setDisplayName(EmptyParam displayName) {
      this.displayName = displayName;
      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
     * TaxRateUpdateParams#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
     * TaxRateUpdateParams#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
     * TaxRateUpdateParams#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 TaxRateUpdateParams#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 jurisdiction for the tax rate. You can use this label field for tax reporting purposes.
     * It also appears on your customer’s invoice.
     */
    public Builder setJurisdiction(String jurisdiction) {
      this.jurisdiction = jurisdiction;
      return this;
    }

    /**
     * The jurisdiction for the tax rate. You can use this label field for tax reporting purposes.
     * It also appears on your customer’s invoice.
     */
    public Builder setJurisdiction(EmptyParam jurisdiction) {
      this.jurisdiction = jurisdiction;
      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
     * TaxRateUpdateParams#metadata} for the field documentation.
     */
    @SuppressWarnings("unchecked")
    public Builder putMetadata(String key, String value) {
      if (this.metadata == null || this.metadata instanceof EmptyParam) {
        this.metadata = new HashMap();
      }
      ((Map) 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 TaxRateUpdateParams#metadata} for the field documentation.
     */
    @SuppressWarnings("unchecked")
    public Builder putAllMetadata(Map map) {
      if (this.metadata == null || this.metadata instanceof EmptyParam) {
        this.metadata = new HashMap();
      }
      ((Map) this.metadata).putAll(map);
      return this;
    }

    /**
     * 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. Individual keys can be unset by posting an empty value to them. All keys
     * can be unset by posting an empty value to {@code metadata}.
     */
    public Builder setMetadata(EmptyParam metadata) {
      this.metadata = metadata;
      return this;
    }

    /**
     * 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. Individual keys can be unset by posting an empty value to them. All keys
     * can be unset by posting an empty value to {@code metadata}.
     */
    public Builder setMetadata(Map metadata) {
      this.metadata = metadata;
      return this;
    }

    /**
     * ISO 3166-2 subdivision code,
     * without country prefix. For example, "NY" for New York, United States.
     */
    public Builder setState(String state) {
      this.state = state;
      return this;
    }

    /**
     * ISO 3166-2 subdivision code,
     * without country prefix. For example, "NY" for New York, United States.
     */
    public Builder setState(EmptyParam state) {
      this.state = state;
      return this;
    }

    /** The high-level tax type, such as {@code vat} or {@code sales_tax}. */
    public Builder setTaxType(TaxRateUpdateParams.TaxType taxType) {
      this.taxType = taxType;
      return this;
    }
  }

  public enum TaxType implements ApiRequestParams.EnumParam {
    @SerializedName("amusement_tax")
    AMUSEMENT_TAX("amusement_tax"),

    @SerializedName("communications_tax")
    COMMUNICATIONS_TAX("communications_tax"),

    @SerializedName("gst")
    GST("gst"),

    @SerializedName("hst")
    HST("hst"),

    @SerializedName("igst")
    IGST("igst"),

    @SerializedName("jct")
    JCT("jct"),

    @SerializedName("lease_tax")
    LEASE_TAX("lease_tax"),

    @SerializedName("pst")
    PST("pst"),

    @SerializedName("qst")
    QST("qst"),

    @SerializedName("rst")
    RST("rst"),

    @SerializedName("sales_tax")
    SALES_TAX("sales_tax"),

    @SerializedName("vat")
    VAT("vat");

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy