com.stripe.model.FileLink Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
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.FileLinkCreateParams;
import com.stripe.param.FileLinkListParams;
import com.stripe.param.FileLinkRetrieveParams;
import com.stripe.param.FileLinkUpdateParams;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* To share the contents of a {@code File} object with non-Stripe users, you can create a {@code
* FileLink}. {@code FileLink}s contain a URL that you can use to retrieve the contents of the file
* without authentication.
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class FileLink extends ApiResource implements HasId, MetadataStore {
/** Time at which the object was created. Measured in seconds since the Unix epoch. */
@SerializedName("created")
Long created;
/** Returns if the link is already expired. */
@SerializedName("expired")
Boolean expired;
/** Time that the link expires. */
@SerializedName("expires_at")
Long expiresAt;
/** The file object this link points to. */
@SerializedName("file")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField file;
/** 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;
/**
* 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.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("metadata")
Map metadata;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code file_link}.
*/
@SerializedName("object")
String object;
/** The publicly accessible URL to download the file. */
@SerializedName("url")
String url;
/** Get ID of expandable {@code file} object. */
public String getFile() {
return (this.file != null) ? this.file.getId() : null;
}
public void setFile(String id) {
this.file = ApiResource.setExpandableFieldId(id, this.file);
}
/** Get expanded {@code file}. */
public File getFileObject() {
return (this.file != null) ? this.file.getExpanded() : null;
}
public void setFileObject(File expandableObject) {
this.file = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Creates a new file link object. */
public static FileLink create(Map params) throws StripeException {
return create(params, (RequestOptions) null);
}
/** Creates a new file link object. */
public static FileLink create(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/file_links";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getGlobalResponseGetter().request(request, FileLink.class);
}
/** Creates a new file link object. */
public static FileLink create(FileLinkCreateParams params) throws StripeException {
return create(params, (RequestOptions) null);
}
/** Creates a new file link object. */
public static FileLink create(FileLinkCreateParams params, RequestOptions options)
throws StripeException {
String path = "/v1/file_links";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, FileLink.class);
}
/** Returns a list of file links. */
public static FileLinkCollection list(Map params) throws StripeException {
return list(params, (RequestOptions) null);
}
/** Returns a list of file links. */
public static FileLinkCollection list(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/file_links";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, FileLinkCollection.class);
}
/** Returns a list of file links. */
public static FileLinkCollection list(FileLinkListParams params) throws StripeException {
return list(params, (RequestOptions) null);
}
/** Returns a list of file links. */
public static FileLinkCollection list(FileLinkListParams params, RequestOptions options)
throws StripeException {
String path = "/v1/file_links";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, FileLinkCollection.class);
}
/** Retrieves the file link with the given ID. */
public static FileLink retrieve(String link) throws StripeException {
return retrieve(link, (Map) null, (RequestOptions) null);
}
/** Retrieves the file link with the given ID. */
public static FileLink retrieve(String link, RequestOptions options) throws StripeException {
return retrieve(link, (Map) null, options);
}
/** Retrieves the file link with the given ID. */
public static FileLink retrieve(String link, Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/file_links/%s", ApiResource.urlEncodeId(link));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, FileLink.class);
}
/** Retrieves the file link with the given ID. */
public static FileLink retrieve(
String link, FileLinkRetrieveParams params, RequestOptions options) throws StripeException {
String path = String.format("/v1/file_links/%s", ApiResource.urlEncodeId(link));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, FileLink.class);
}
/** Updates an existing file link object. Expired links can no longer be updated. */
@Override
public FileLink update(Map params) throws StripeException {
return update(params, (RequestOptions) null);
}
/** Updates an existing file link object. Expired links can no longer be updated. */
@Override
public FileLink update(Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/file_links/%s", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, FileLink.class);
}
/** Updates an existing file link object. Expired links can no longer be updated. */
public FileLink update(FileLinkUpdateParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/** Updates an existing file link object. Expired links can no longer be updated. */
public FileLink update(FileLinkUpdateParams params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/file_links/%s", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, FileLink.class);
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(file, responseGetter);
}
}