com.files.models.Bundle Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of files-sdk Show documentation
Show all versions of files-sdk Show documentation
The Files.com Java client library provides convenient access to the Files.com API from JVM based applications.
package com.files.models;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.json.JsonMapper;
import com.files.FilesClient;
import com.files.FilesConfig;
import com.files.ListIterator;
import com.files.net.HttpMethods.RequestMethods;
import com.files.util.FilesInputStream;
import com.files.util.ModelUtils;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
import lombok.Setter;
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Bundle {
private HashMap options;
private ObjectMapper objectMapper = JsonMapper
.builder()
.disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS)
.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
.defaultDateFormat(new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssX"))
.build();
public Bundle() {
this(null, null);
}
public Bundle(HashMap parameters) {
this(parameters, null);
}
public Bundle(HashMap parameters, HashMap options) {
this.options = options;
try {
ObjectReader objectReader = objectMapper.readerForUpdating(this);
objectReader.readValue(objectMapper.writeValueAsString(parameters));
} catch (JsonProcessingException e) {
// TODO: error generation on constructor
}
}
/**
* Bundle code. This code forms the end part of the Public URL.
*/
@Getter
@Setter
@JsonProperty("code")
public String code;
/**
* Page link and button color
*/
@Getter
@Setter
@JsonProperty("color_left")
public String colorLeft;
/**
* Top bar link color
*/
@Getter
@Setter
@JsonProperty("color_link")
public String colorLink;
/**
* Page link and button color
*/
@Getter
@Setter
@JsonProperty("color_text")
public String colorText;
/**
* Top bar background color
*/
@Getter
@Setter
@JsonProperty("color_top")
public String colorTop;
/**
* Top bar text color
*/
@Getter
@Setter
@JsonProperty("color_top_text")
public String colorTopText;
/**
* Public URL of Share Link
*/
@Getter
@Setter
@JsonProperty("url")
public String url;
/**
* Public description
*/
@Getter
@Setter
@JsonProperty("description")
public String description;
/**
* Bundle expiration date/time
*/
@Getter
@Setter
@JsonProperty("expires_at")
public Date expiresAt;
/**
* Is this bundle password protected?
*/
@Getter
@Setter
@JsonProperty("password_protected")
public Boolean passwordProtected;
/**
* Permissions that apply to Folders in this Share Link.
*/
@Getter
@Setter
@JsonProperty("permissions")
public String permissions;
/**
* DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
*/
@Getter
@Setter
@JsonProperty("preview_only")
public Boolean previewOnly;
/**
* Show a registration page that captures the downloader's name and email address?
*/
@Getter
@Setter
@JsonProperty("require_registration")
public Boolean requireRegistration;
/**
* Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
*/
@Getter
@Setter
@JsonProperty("require_share_recipient")
public Boolean requireShareRecipient;
/**
* If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
*/
@Getter
@Setter
@JsonProperty("require_logout")
public Boolean requireLogout;
/**
* Legal text that must be agreed to prior to accessing Bundle.
*/
@Getter
@Setter
@JsonProperty("clickwrap_body")
public String clickwrapBody;
/**
* Custom Form to use
*/
@Getter
@Setter
@JsonProperty("form_field_set")
public FormFieldSet formFieldSet;
/**
* BundleRegistrations can be saved without providing name?
*/
@Getter
@Setter
@JsonProperty("skip_name")
public Boolean skipName;
/**
* BundleRegistrations can be saved without providing email?
*/
@Getter
@Setter
@JsonProperty("skip_email")
public Boolean skipEmail;
/**
* Date when share will start to be accessible. If `nil` access granted right after create.
*/
@Getter
@Setter
@JsonProperty("start_access_on_date")
public Date startAccessOnDate;
/**
* BundleRegistrations can be saved without providing company?
*/
@Getter
@Setter
@JsonProperty("skip_company")
public Boolean skipCompany;
/**
* Bundle ID
*/
@Getter
@Setter
@JsonProperty("id")
public Long id;
/**
* Bundle created at date/time
*/
@Getter
@JsonProperty("created_at")
public Date createdAt;
/**
* Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
*/
@Getter
@Setter
@JsonProperty("dont_separate_submissions_by_folder")
public Boolean dontSeparateSubmissionsByFolder;
/**
* Maximum number of times bundle can be accessed
*/
@Getter
@Setter
@JsonProperty("max_uses")
public Long maxUses;
/**
* Bundle internal note
*/
@Getter
@Setter
@JsonProperty("note")
public String note;
/**
* Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
*/
@Getter
@Setter
@JsonProperty("path_template")
public String pathTemplate;
/**
* Timezone to use when rendering timestamps in path templates.
*/
@Getter
@Setter
@JsonProperty("path_template_time_zone")
public String pathTemplateTimeZone;
/**
* Send delivery receipt to the uploader. Note: For writable share only
*/
@Getter
@Setter
@JsonProperty("send_email_receipt_to_uploader")
public Boolean sendEmailReceiptToUploader;
/**
* ID of the snapshot containing this bundle's contents.
*/
@Getter
@Setter
@JsonProperty("snapshot_id")
public Long snapshotId;
/**
* Bundle creator user ID
*/
@Getter
@Setter
@JsonProperty("user_id")
public Long userId;
/**
* Bundle creator username
*/
@Getter
@Setter
@JsonProperty("username")
public String username;
/**
* ID of the clickwrap to use with this bundle.
*/
@Getter
@Setter
@JsonProperty("clickwrap_id")
public Long clickwrapId;
/**
* ID of the associated inbox, if available.
*/
@Getter
@Setter
@JsonProperty("inbox_id")
public Long inboxId;
/**
* Preview watermark image applied to all bundle items.
*/
@Getter
@Setter
@JsonProperty("watermark_attachment")
public Image watermarkAttachment;
/**
* Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
*/
@Getter
@Setter
@JsonProperty("watermark_value")
public Map watermarkValue;
/**
* Does this bundle have an associated inbox?
*/
@Getter
@Setter
@JsonProperty("has_inbox")
public Boolean hasInbox;
/**
* A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
*/
@Getter
@Setter
@JsonProperty("paths")
public Object[] paths;
/**
* A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
*/
@Getter
@Setter
@JsonProperty("bundlepaths")
public Object[] bundlepaths;
/**
* Password for this bundle.
*/
@Getter
@Setter
@JsonProperty("password")
public String password;
/**
* Id of Form Field Set to use with this bundle
*/
@Getter
@Setter
@JsonProperty("form_field_set_id")
public Long formFieldSetId;
/**
* If true, create a snapshot of this bundle's contents.
*/
@Getter
@Setter
@JsonProperty("create_snapshot")
public Boolean createSnapshot;
/**
* If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
*/
@Getter
@Setter
@JsonProperty("finalize_snapshot")
public Boolean finalizeSnapshot;
/**
* Preview watermark image applied to all bundle items.
*/
@Getter
@Setter
@JsonProperty("watermark_attachment_file")
public byte[] watermarkAttachmentFile;
/**
* If true, will delete the file stored in watermark_attachment
*/
@Getter
@Setter
@JsonProperty("watermark_attachment_delete")
public Boolean watermarkAttachmentDelete;
/**
* Send email(s) with a link to bundle
*
* Parameters:
* to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
* note - string - Note to include in email.
* recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
*/
public void share(HashMap parameters) {
share(parameters);
}
/**
* Parameters:
* paths - array(string) - A list of paths to include in this bundle.
* password - string - Password for this bundle.
* form_field_set_id - int64 - Id of Form Field Set to use with this bundle
* clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
* code - string - Bundle code. This code forms the end part of the Public URL.
* create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
* description - string - Public description
* dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
* expires_at - string - Bundle expiration date/time
* finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
* inbox_id - int64 - ID of the associated inbox, if available.
* max_uses - int64 - Maximum number of times bundle can be accessed
* note - string - Bundle internal note
* path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
* path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
* permissions - string - Permissions that apply to Folders in this Share Link.
* preview_only - boolean - DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
* require_registration - boolean - Show a registration page that captures the downloader's name and email address?
* require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
* send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
* skip_company - boolean - BundleRegistrations can be saved without providing company?
* start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
* skip_email - boolean - BundleRegistrations can be saved without providing email?
* skip_name - boolean - BundleRegistrations can be saved without providing name?
* watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
* watermark_attachment_file - file - Preview watermark image applied to all bundle items.
*/
public Bundle update(HashMap parameters) {
return update(parameters);
}
/**
*/
public void delete(HashMap parameters) {
delete(parameters);
}
public void destroy(HashMap parameters) {
delete(parameters);
}
public void save() throws IOException {
HashMap parameters = ModelUtils.toParameterMap(objectMapper.writeValueAsString(this));
if (parameters.containsKey("id") && parameters.get("id") != null) {
update(parameters);
} else {
Bundle.create(parameters, this.options);
}
}
/**
* Parameters:
* user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
* cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `code`.
* filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
* filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
* filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
* filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
* filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
*/
public static ListIterator list() throws RuntimeException {
return list(null, null);
}
public static ListIterator list(HashMap parameters) throws RuntimeException {
return list(parameters, null);
}
public static ListIterator list(HashMap parameters, HashMap options) throws RuntimeException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (parameters.containsKey("user_id") && !(parameters.get("user_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: user_id must be of type Long parameters[\"user_id\"]");
}
if (parameters.containsKey("cursor") && !(parameters.get("cursor") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: cursor must be of type String parameters[\"cursor\"]");
}
if (parameters.containsKey("per_page") && !(parameters.get("per_page") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: per_page must be of type Long parameters[\"per_page\"]");
}
if (parameters.containsKey("sort_by") && !(parameters.get("sort_by") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: sort_by must be of type Map parameters[\"sort_by\"]");
}
if (parameters.containsKey("filter") && !(parameters.get("filter") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: filter must be of type Map parameters[\"filter\"]");
}
if (parameters.containsKey("filter_gt") && !(parameters.get("filter_gt") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: filter_gt must be of type Map parameters[\"filter_gt\"]");
}
if (parameters.containsKey("filter_gteq") && !(parameters.get("filter_gteq") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: filter_gteq must be of type Map parameters[\"filter_gteq\"]");
}
if (parameters.containsKey("filter_lt") && !(parameters.get("filter_lt") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: filter_lt must be of type Map parameters[\"filter_lt\"]");
}
if (parameters.containsKey("filter_lteq") && !(parameters.get("filter_lteq") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: filter_lteq must be of type Map parameters[\"filter_lteq\"]");
}
String url = String.format("%s%s/bundles", FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase());
TypeReference> typeReference = new TypeReference>() {};
return FilesClient.requestList(url, RequestMethods.GET, typeReference, parameters, options);
}
public static ListIterator all() throws RuntimeException {
return all(null, null);
}
public static ListIterator all(HashMap parameters, HashMap options) throws RuntimeException {
return list(parameters, options);
}
/**
* Parameters:
* id (required) - int64 - Bundle ID.
*/
public static Bundle find() throws RuntimeException {
return find(null, null, null);
}
public static Bundle find(Long id, HashMap parameters) throws RuntimeException {
return find(id, parameters, null);
}
public static Bundle find(HashMap parameters, HashMap options) throws RuntimeException {
return find(null, parameters, options);
}
public static Bundle find(Long id, HashMap parameters, HashMap options) throws RuntimeException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (id == null && parameters.containsKey("id") && parameters.get("id") != null) {
id = (Long) parameters.get("id");
}
if (id == null) {
throw new NullPointerException("Argument or Parameter missing: id parameters[\"id\"]");
}
if (!(id instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: id must be of type Long parameters[\"id\"]");
}
String urlParts[] = {FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase(), String.valueOf(id)};
for (int i = 2; i < urlParts.length; i++) {
try {
urlParts[i] = new URI(null, null, urlParts[i], null).getRawPath();
} catch (URISyntaxException ex) {
// NOOP
}
}
String url = String.format("%s%s/bundles/%s", urlParts);
TypeReference typeReference = new TypeReference() {};
return FilesClient.requestItem(url, RequestMethods.GET, typeReference, parameters, options);
}
public static Bundle get() throws RuntimeException {
return get(null, null, null);
}
public static Bundle get(Long id, HashMap parameters, HashMap options) throws RuntimeException {
return find(id, parameters, options);
}
/**
* Parameters:
* user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
* paths (required) - array(string) - A list of paths to include in this bundle.
* password - string - Password for this bundle.
* form_field_set_id - int64 - Id of Form Field Set to use with this bundle
* create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
* dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
* expires_at - string - Bundle expiration date/time
* finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
* max_uses - int64 - Maximum number of times bundle can be accessed
* description - string - Public description
* note - string - Bundle internal note
* code - string - Bundle code. This code forms the end part of the Public URL.
* path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
* path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
* permissions - string - Permissions that apply to Folders in this Share Link.
* preview_only - boolean - DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
* require_registration - boolean - Show a registration page that captures the downloader's name and email address?
* clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
* inbox_id - int64 - ID of the associated inbox, if available.
* require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
* send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
* skip_email - boolean - BundleRegistrations can be saved without providing email?
* skip_name - boolean - BundleRegistrations can be saved without providing name?
* skip_company - boolean - BundleRegistrations can be saved without providing company?
* start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
* snapshot_id - int64 - ID of the snapshot containing this bundle's contents.
* watermark_attachment_file - file - Preview watermark image applied to all bundle items.
*/
public static Bundle create() throws RuntimeException {
return create(null, null);
}
public static Bundle create(HashMap parameters) throws RuntimeException {
return create(parameters, null);
}
public static Bundle create(HashMap parameters, HashMap options) throws RuntimeException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (!parameters.containsKey("paths") || parameters.get("paths") == null) {
throw new NullPointerException("Parameter missing: paths parameters[\"paths\"]");
}
if (parameters.containsKey("user_id") && !(parameters.get("user_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: user_id must be of type Long parameters[\"user_id\"]");
}
if (parameters.containsKey("paths") && !(parameters.get("paths") instanceof String[])) {
throw new IllegalArgumentException("Bad parameter: paths must be of type String[] parameters[\"paths\"]");
}
if (parameters.containsKey("password") && !(parameters.get("password") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: password must be of type String parameters[\"password\"]");
}
if (parameters.containsKey("form_field_set_id") && !(parameters.get("form_field_set_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: form_field_set_id must be of type Long parameters[\"form_field_set_id\"]");
}
if (parameters.containsKey("create_snapshot") && !(parameters.get("create_snapshot") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: create_snapshot must be of type Boolean parameters[\"create_snapshot\"]");
}
if (parameters.containsKey("dont_separate_submissions_by_folder") && !(parameters.get("dont_separate_submissions_by_folder") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: dont_separate_submissions_by_folder must be of type Boolean parameters[\"dont_separate_submissions_by_folder\"]");
}
if (parameters.containsKey("expires_at") && !(parameters.get("expires_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: expires_at must be of type String parameters[\"expires_at\"]");
}
if (parameters.containsKey("finalize_snapshot") && !(parameters.get("finalize_snapshot") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: finalize_snapshot must be of type Boolean parameters[\"finalize_snapshot\"]");
}
if (parameters.containsKey("max_uses") && !(parameters.get("max_uses") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: max_uses must be of type Long parameters[\"max_uses\"]");
}
if (parameters.containsKey("description") && !(parameters.get("description") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: description must be of type String parameters[\"description\"]");
}
if (parameters.containsKey("note") && !(parameters.get("note") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: note must be of type String parameters[\"note\"]");
}
if (parameters.containsKey("code") && !(parameters.get("code") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: code must be of type String parameters[\"code\"]");
}
if (parameters.containsKey("path_template") && !(parameters.get("path_template") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: path_template must be of type String parameters[\"path_template\"]");
}
if (parameters.containsKey("path_template_time_zone") && !(parameters.get("path_template_time_zone") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: path_template_time_zone must be of type String parameters[\"path_template_time_zone\"]");
}
if (parameters.containsKey("permissions") && !(parameters.get("permissions") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: permissions must be of type String parameters[\"permissions\"]");
}
if (parameters.containsKey("preview_only") && !(parameters.get("preview_only") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: preview_only must be of type Boolean parameters[\"preview_only\"]");
}
if (parameters.containsKey("require_registration") && !(parameters.get("require_registration") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: require_registration must be of type Boolean parameters[\"require_registration\"]");
}
if (parameters.containsKey("clickwrap_id") && !(parameters.get("clickwrap_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: clickwrap_id must be of type Long parameters[\"clickwrap_id\"]");
}
if (parameters.containsKey("inbox_id") && !(parameters.get("inbox_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: inbox_id must be of type Long parameters[\"inbox_id\"]");
}
if (parameters.containsKey("require_share_recipient") && !(parameters.get("require_share_recipient") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: require_share_recipient must be of type Boolean parameters[\"require_share_recipient\"]");
}
if (parameters.containsKey("send_email_receipt_to_uploader") && !(parameters.get("send_email_receipt_to_uploader") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: send_email_receipt_to_uploader must be of type Boolean parameters[\"send_email_receipt_to_uploader\"]");
}
if (parameters.containsKey("skip_email") && !(parameters.get("skip_email") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: skip_email must be of type Boolean parameters[\"skip_email\"]");
}
if (parameters.containsKey("skip_name") && !(parameters.get("skip_name") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: skip_name must be of type Boolean parameters[\"skip_name\"]");
}
if (parameters.containsKey("skip_company") && !(parameters.get("skip_company") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: skip_company must be of type Boolean parameters[\"skip_company\"]");
}
if (parameters.containsKey("start_access_on_date") && !(parameters.get("start_access_on_date") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: start_access_on_date must be of type String parameters[\"start_access_on_date\"]");
}
if (parameters.containsKey("snapshot_id") && !(parameters.get("snapshot_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: snapshot_id must be of type Long parameters[\"snapshot_id\"]");
}
if (parameters.containsKey("watermark_attachment_file") && !(parameters.get("watermark_attachment_file") instanceof byte[])) {
throw new IllegalArgumentException("Bad parameter: watermark_attachment_file must be of type byte[] parameters[\"watermark_attachment_file\"]");
}
String url = String.format("%s%s/bundles", FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase());
TypeReference typeReference = new TypeReference() {};
return FilesClient.requestItem(url, RequestMethods.POST, typeReference, parameters, options);
}
/**
* Send email(s) with a link to bundle
*
* Parameters:
* to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
* note - string - Note to include in email.
* recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
*/
public static void share() throws RuntimeException {
share(null, null, null);
}
public static void share(Long id, HashMap parameters) throws RuntimeException {
share(id, parameters, null);
}
public static void share(HashMap parameters, HashMap options) throws RuntimeException {
share(null, parameters, options);
}
public static void share(Long id, HashMap parameters, HashMap options) throws RuntimeException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (id == null && parameters.containsKey("id") && parameters.get("id") != null) {
id = (Long) parameters.get("id");
}
if (id == null) {
throw new NullPointerException("Argument or Parameter missing: id parameters[\"id\"]");
}
if (!(id instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: id must be of type Long parameters[\"id\"]");
}
if (parameters.containsKey("to") && !(parameters.get("to") instanceof String[])) {
throw new IllegalArgumentException("Bad parameter: to must be of type String[] parameters[\"to\"]");
}
if (parameters.containsKey("note") && !(parameters.get("note") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: note must be of type String parameters[\"note\"]");
}
if (parameters.containsKey("recipients") && !(parameters.get("recipients") instanceof Object[])) {
throw new IllegalArgumentException("Bad parameter: recipients must be of type Object[] parameters[\"recipients\"]");
}
String urlParts[] = {FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase(), String.valueOf(id)};
for (int i = 2; i < urlParts.length; i++) {
try {
urlParts[i] = new URI(null, null, urlParts[i], null).getRawPath();
} catch (URISyntaxException ex) {
// NOOP
}
}
String url = String.format("%s%s/bundles/%s/share", urlParts);
FilesClient.apiRequest(url, RequestMethods.POST, parameters, options);
}
/**
* Parameters:
* paths - array(string) - A list of paths to include in this bundle.
* password - string - Password for this bundle.
* form_field_set_id - int64 - Id of Form Field Set to use with this bundle
* clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
* code - string - Bundle code. This code forms the end part of the Public URL.
* create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
* description - string - Public description
* dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
* expires_at - string - Bundle expiration date/time
* finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
* inbox_id - int64 - ID of the associated inbox, if available.
* max_uses - int64 - Maximum number of times bundle can be accessed
* note - string - Bundle internal note
* path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
* path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
* permissions - string - Permissions that apply to Folders in this Share Link.
* preview_only - boolean - DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
* require_registration - boolean - Show a registration page that captures the downloader's name and email address?
* require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
* send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
* skip_company - boolean - BundleRegistrations can be saved without providing company?
* start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
* skip_email - boolean - BundleRegistrations can be saved without providing email?
* skip_name - boolean - BundleRegistrations can be saved without providing name?
* watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
* watermark_attachment_file - file - Preview watermark image applied to all bundle items.
*/
public static Bundle update() throws RuntimeException {
return update(null, null, null);
}
public static Bundle update(Long id, HashMap parameters) throws RuntimeException {
return update(id, parameters, null);
}
public static Bundle update(HashMap parameters, HashMap options) throws RuntimeException {
return update(null, parameters, options);
}
public static Bundle update(Long id, HashMap parameters, HashMap options) throws RuntimeException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (id == null && parameters.containsKey("id") && parameters.get("id") != null) {
id = (Long) parameters.get("id");
}
if (id == null) {
throw new NullPointerException("Argument or Parameter missing: id parameters[\"id\"]");
}
if (!(id instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: id must be of type Long parameters[\"id\"]");
}
if (parameters.containsKey("paths") && !(parameters.get("paths") instanceof String[])) {
throw new IllegalArgumentException("Bad parameter: paths must be of type String[] parameters[\"paths\"]");
}
if (parameters.containsKey("password") && !(parameters.get("password") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: password must be of type String parameters[\"password\"]");
}
if (parameters.containsKey("form_field_set_id") && !(parameters.get("form_field_set_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: form_field_set_id must be of type Long parameters[\"form_field_set_id\"]");
}
if (parameters.containsKey("clickwrap_id") && !(parameters.get("clickwrap_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: clickwrap_id must be of type Long parameters[\"clickwrap_id\"]");
}
if (parameters.containsKey("code") && !(parameters.get("code") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: code must be of type String parameters[\"code\"]");
}
if (parameters.containsKey("create_snapshot") && !(parameters.get("create_snapshot") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: create_snapshot must be of type Boolean parameters[\"create_snapshot\"]");
}
if (parameters.containsKey("description") && !(parameters.get("description") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: description must be of type String parameters[\"description\"]");
}
if (parameters.containsKey("dont_separate_submissions_by_folder") && !(parameters.get("dont_separate_submissions_by_folder") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: dont_separate_submissions_by_folder must be of type Boolean parameters[\"dont_separate_submissions_by_folder\"]");
}
if (parameters.containsKey("expires_at") && !(parameters.get("expires_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: expires_at must be of type String parameters[\"expires_at\"]");
}
if (parameters.containsKey("finalize_snapshot") && !(parameters.get("finalize_snapshot") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: finalize_snapshot must be of type Boolean parameters[\"finalize_snapshot\"]");
}
if (parameters.containsKey("inbox_id") && !(parameters.get("inbox_id") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: inbox_id must be of type Long parameters[\"inbox_id\"]");
}
if (parameters.containsKey("max_uses") && !(parameters.get("max_uses") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: max_uses must be of type Long parameters[\"max_uses\"]");
}
if (parameters.containsKey("note") && !(parameters.get("note") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: note must be of type String parameters[\"note\"]");
}
if (parameters.containsKey("path_template") && !(parameters.get("path_template") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: path_template must be of type String parameters[\"path_template\"]");
}
if (parameters.containsKey("path_template_time_zone") && !(parameters.get("path_template_time_zone") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: path_template_time_zone must be of type String parameters[\"path_template_time_zone\"]");
}
if (parameters.containsKey("permissions") && !(parameters.get("permissions") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: permissions must be of type String parameters[\"permissions\"]");
}
if (parameters.containsKey("preview_only") && !(parameters.get("preview_only") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: preview_only must be of type Boolean parameters[\"preview_only\"]");
}
if (parameters.containsKey("require_registration") && !(parameters.get("require_registration") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: require_registration must be of type Boolean parameters[\"require_registration\"]");
}
if (parameters.containsKey("require_share_recipient") && !(parameters.get("require_share_recipient") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: require_share_recipient must be of type Boolean parameters[\"require_share_recipient\"]");
}
if (parameters.containsKey("send_email_receipt_to_uploader") && !(parameters.get("send_email_receipt_to_uploader") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: send_email_receipt_to_uploader must be of type Boolean parameters[\"send_email_receipt_to_uploader\"]");
}
if (parameters.containsKey("skip_company") && !(parameters.get("skip_company") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: skip_company must be of type Boolean parameters[\"skip_company\"]");
}
if (parameters.containsKey("start_access_on_date") && !(parameters.get("start_access_on_date") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: start_access_on_date must be of type String parameters[\"start_access_on_date\"]");
}
if (parameters.containsKey("skip_email") && !(parameters.get("skip_email") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: skip_email must be of type Boolean parameters[\"skip_email\"]");
}
if (parameters.containsKey("skip_name") && !(parameters.get("skip_name") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: skip_name must be of type Boolean parameters[\"skip_name\"]");
}
if (parameters.containsKey("watermark_attachment_delete") && !(parameters.get("watermark_attachment_delete") instanceof Boolean)) {
throw new IllegalArgumentException("Bad parameter: watermark_attachment_delete must be of type Boolean parameters[\"watermark_attachment_delete\"]");
}
if (parameters.containsKey("watermark_attachment_file") && !(parameters.get("watermark_attachment_file") instanceof byte[])) {
throw new IllegalArgumentException("Bad parameter: watermark_attachment_file must be of type byte[] parameters[\"watermark_attachment_file\"]");
}
String urlParts[] = {FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase(), String.valueOf(id)};
for (int i = 2; i < urlParts.length; i++) {
try {
urlParts[i] = new URI(null, null, urlParts[i], null).getRawPath();
} catch (URISyntaxException ex) {
// NOOP
}
}
String url = String.format("%s%s/bundles/%s", urlParts);
TypeReference typeReference = new TypeReference() {};
return FilesClient.requestItem(url, RequestMethods.PATCH, typeReference, parameters, options);
}
/**
*/
public static void delete() throws RuntimeException {
delete(null, null, null);
}
public static void delete(Long id, HashMap parameters) throws RuntimeException {
delete(id, parameters, null);
}
public static void delete(HashMap parameters, HashMap options) throws RuntimeException {
delete(null, parameters, options);
}
public static void delete(Long id, HashMap parameters, HashMap options) throws RuntimeException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (id == null && parameters.containsKey("id") && parameters.get("id") != null) {
id = (Long) parameters.get("id");
}
if (id == null) {
throw new NullPointerException("Argument or Parameter missing: id parameters[\"id\"]");
}
if (!(id instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: id must be of type Long parameters[\"id\"]");
}
String urlParts[] = {FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase(), String.valueOf(id)};
for (int i = 2; i < urlParts.length; i++) {
try {
urlParts[i] = new URI(null, null, urlParts[i], null).getRawPath();
} catch (URISyntaxException ex) {
// NOOP
}
}
String url = String.format("%s%s/bundles/%s", urlParts);
FilesClient.apiRequest(url, RequestMethods.DELETE, parameters, options);
}
public static void destroy() throws RuntimeException {
destroy(null, null, null);
}
public static void destroy(Long id, HashMap parameters, HashMap options) throws RuntimeException {
delete(id, parameters, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy