com.stripe.model.issuing.PhysicalBundle Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model.issuing;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.model.HasId;
import com.stripe.model.StripeObject;
import com.stripe.net.ApiMode;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.issuing.PhysicalBundleListParams;
import com.stripe.param.issuing.PhysicalBundleRetrieveParams;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and
* envelope - that is shipped to a cardholder when you create a physical card.
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class PhysicalBundle extends ApiResource implements HasId {
@SerializedName("features")
Features features;
/** Unique identifier for the object. */
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@SerializedName("livemode")
Boolean livemode;
/** Friendly display name. */
@SerializedName("name")
String name;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code issuing.physical_bundle}.
*/
@SerializedName("object")
String object;
/**
* Whether this physical bundle can be used to create cards.
*
*
One of {@code active}, {@code inactive}, or {@code review}.
*/
@SerializedName("status")
String status;
/**
* Whether this physical bundle is a standard Stripe offering or custom-made for you.
*
*
One of {@code custom}, or {@code standard}.
*/
@SerializedName("type")
String type;
/**
* Returns a list of physical bundle objects. The objects are sorted in descending order by
* creation date, with the most recently created object appearing first.
*/
public static PhysicalBundleCollection list(Map params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* Returns a list of physical bundle objects. The objects are sorted in descending order by
* creation date, with the most recently created object appearing first.
*/
public static PhysicalBundleCollection list(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/issuing/physical_bundles";
ApiRequest request =
new ApiRequest(
BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options, ApiMode.V1);
return getGlobalResponseGetter().request(request, PhysicalBundleCollection.class);
}
/**
* Returns a list of physical bundle objects. The objects are sorted in descending order by
* creation date, with the most recently created object appearing first.
*/
public static PhysicalBundleCollection list(PhysicalBundleListParams params)
throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* Returns a list of physical bundle objects. The objects are sorted in descending order by
* creation date, with the most recently created object appearing first.
*/
public static PhysicalBundleCollection list(
PhysicalBundleListParams params, RequestOptions options) throws StripeException {
String path = "/v1/issuing/physical_bundles";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options,
ApiMode.V1);
return getGlobalResponseGetter().request(request, PhysicalBundleCollection.class);
}
/** Retrieves a physical bundle object. */
public static PhysicalBundle retrieve(String physicalBundle) throws StripeException {
return retrieve(physicalBundle, (Map) null, (RequestOptions) null);
}
/** Retrieves a physical bundle object. */
public static PhysicalBundle retrieve(String physicalBundle, RequestOptions options)
throws StripeException {
return retrieve(physicalBundle, (Map) null, options);
}
/** Retrieves a physical bundle object. */
public static PhysicalBundle retrieve(
String physicalBundle, Map params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/issuing/physical_bundles/%s", ApiResource.urlEncodeId(physicalBundle));
ApiRequest request =
new ApiRequest(
BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options, ApiMode.V1);
return getGlobalResponseGetter().request(request, PhysicalBundle.class);
}
/** Retrieves a physical bundle object. */
public static PhysicalBundle retrieve(
String physicalBundle, PhysicalBundleRetrieveParams params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/issuing/physical_bundles/%s", ApiResource.urlEncodeId(physicalBundle));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options,
ApiMode.V1);
return getGlobalResponseGetter().request(request, PhysicalBundle.class);
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Features extends StripeObject {
/**
* The policy for how to use card logo images in a card design with this physical bundle.
*
* One of {@code optional}, {@code required}, or {@code unsupported}.
*/
@SerializedName("card_logo")
String cardLogo;
/**
* The policy for how to use carrier letter text in a card design with this physical bundle.
*
*
One of {@code optional}, {@code required}, or {@code unsupported}.
*/
@SerializedName("carrier_text")
String carrierText;
/**
* The policy for how to use a second line on a card with this physical bundle.
*
*
One of {@code optional}, {@code required}, or {@code unsupported}.
*/
@SerializedName("second_line")
String secondLine;
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(features, responseGetter);
}
}