@@ -183,7 +185,7 @@
org.projectlombok
lombok
- 1.18.30
+ 1.18.42
diff --git a/prettier.config.js b/prettier.config.js
new file mode 100644
index 0000000..42070c2
--- /dev/null
+++ b/prettier.config.js
@@ -0,0 +1,39 @@
+// Prettier configuration for code-formatter lambda
+// Aligned with sdk-gen/prettier.config.ts
+
+module.exports = {
+ printWidth: 100,
+ tabWidth: 2,
+ useTabs: false,
+ semi: true,
+ singleQuote: true,
+ quoteProps: 'as-needed',
+ jsxSingleQuote: false,
+ trailingComma: 'all',
+ bracketSpacing: true,
+ arrowParens: 'always',
+ overrides: [
+ {
+ files: '.editorconfig',
+ options: { parser: 'yaml' },
+ },
+ {
+ files: 'LICENSE',
+ options: { parser: 'markdown' },
+ },
+ {
+ files: '*.php',
+ options: {
+ parser: 'php',
+ phpVersion: '8.0',
+ trailingCommaPHP: false,
+ },
+ },
+ {
+ files: '*.md',
+ options: {
+ parser: 'markdown',
+ },
+ },
+ ],
+};
diff --git a/src/main/java/com/alohi/signplus/Signplus.java b/src/main/java/com/alohi/signplus/Signplus.java
index 79ef2a6..522601b 100644
--- a/src/main/java/com/alohi/signplus/Signplus.java
+++ b/src/main/java/com/alohi/signplus/Signplus.java
@@ -8,18 +8,29 @@
import java.util.concurrent.TimeUnit;
import okhttp3.OkHttpClient;
-/** Integrate legally-binding electronic signature to your workflow */
+/**
+ * Integrate legally-binding electronic signature to your workflow
+ */
public class Signplus {
public final SignplusService signplus;
private final SignplusConfig config;
+ /**
+ * Constructs a new instance of Signplus with default configuration.
+ */
public Signplus() {
// Default configs
this(SignplusConfig.builder().build());
}
+ /**
+ * Constructs a new instance of Signplus with custom configuration.
+ * Initializes all services, HTTP client, and optional OAuth token manager.
+ *
+ * @param config The SDK configuration including base URL, authentication, timeout, and retry settings
+ */
public Signplus(SignplusConfig config) {
this.config = config;
@@ -32,14 +43,29 @@ public Signplus(SignplusConfig config) {
this.signplus = new SignplusService(httpClient, config);
}
+ /**
+ * Sets the environment for all API requests.
+ *
+ * @param environment The environment to use (e.g., DEFAULT, PRODUCTION, STAGING)
+ */
public void setEnvironment(Environment environment) {
setBaseUrl(environment.getUrl());
}
+ /**
+ * Sets the base URL for all API requests.
+ *
+ * @param baseUrl The base URL to use for API requests
+ */
public void setBaseUrl(String baseUrl) {
this.config.setBaseUrl(baseUrl);
}
+ /**
+ * Sets the access token (Bearer token) for all API requests.
+ *
+ * @param token The access token to use for authentication
+ */
public void setAccessToken(String token) {
this.config.setAccessToken(token);
}
diff --git a/src/main/java/com/alohi/signplus/config/RequestConfig.java b/src/main/java/com/alohi/signplus/config/RequestConfig.java
new file mode 100644
index 0000000..b6b451c
--- /dev/null
+++ b/src/main/java/com/alohi/signplus/config/RequestConfig.java
@@ -0,0 +1,60 @@
+package com.alohi.signplus.config;
+
+import com.alohi.signplus.http.Environment;
+import lombok.Builder;
+import lombok.Data;
+
+/**
+ * Configuration class for request-level, method-level, and service-level overrides.
+ *
+ * Provides a hierarchical configuration override mechanism with the following priority
+ * (highest to lowest):
+ *
+ * - Request config - passed directly to a method call
+ * - Method config - set via {@code setConfig()} on a service
+ * - Service config - set via {@code setConfig()} on a service
+ * - SDK config - set at SDK initialization
+ *
+ *
+ * All fields are optional (nullable). Only non-null fields will override the corresponding
+ * SDK-level configuration values.
+ */
+@Builder
+@Data
+public class RequestConfig {
+
+ /** Override the base URL for API requests. */
+ private String baseUrl;
+
+ /** Override the environment for API requests. */
+ private Environment environment;
+
+ /** Override the request timeout in milliseconds. */
+ private Long timeout;
+
+ /** Override the access token (Bearer token) for authentication. */
+ private String accessToken;
+
+ /** Override the retry configuration. */
+ private RetryConfig retryConfig;
+
+ /**
+ * Merges multiple {@link RequestConfig} instances in order. Later configs take precedence
+ * over earlier ones for any non-null field.
+ *
+ * @param configs The configs to merge (in order of increasing priority)
+ * @return A new merged {@link RequestConfig}
+ */
+ public static RequestConfig merge(RequestConfig... configs) {
+ RequestConfigBuilder builder = RequestConfig.builder();
+ for (RequestConfig cfg : configs) {
+ if (cfg == null) continue;
+ if (cfg.getBaseUrl() != null) builder.baseUrl(cfg.getBaseUrl());
+ if (cfg.getEnvironment() != null) builder.environment(cfg.getEnvironment());
+ if (cfg.getTimeout() != null) builder.timeout(cfg.getTimeout());
+ if (cfg.getAccessToken() != null) builder.accessToken(cfg.getAccessToken());
+ if (cfg.getRetryConfig() != null) builder.retryConfig(cfg.getRetryConfig());
+ }
+ return builder.build();
+ }
+}
diff --git a/src/main/java/com/alohi/signplus/config/RetryConfig.java b/src/main/java/com/alohi/signplus/config/RetryConfig.java
index 99c602c..a2b139f 100644
--- a/src/main/java/com/alohi/signplus/config/RetryConfig.java
+++ b/src/main/java/com/alohi/signplus/config/RetryConfig.java
@@ -5,10 +5,16 @@
import java.net.SocketException;
import java.net.SocketTimeoutException;
import java.util.Arrays;
+import java.util.Collections;
import java.util.List;
import lombok.Builder;
import lombok.Data;
+/**
+ * Configuration for automatic retry behavior on failed requests.
+ * Defines retry limits, backoff strategy, and conditions for retrying requests.
+ * Uses builder pattern for flexible configuration with sensible defaults.
+ */
@Data
@Builder
public class RetryConfig {
@@ -29,7 +35,7 @@ public class RetryConfig {
private int jitter = 50;
@Builder.Default
- private List statusCodesToRetry = Arrays.asList(408, 429, 500, 502, 503, 504);
+ private List statusCodesToRetry = Collections.emptyList();
@Builder.Default
private List httpMethodsToRetry = Arrays.asList(
diff --git a/src/main/java/com/alohi/signplus/config/SignplusConfig.java b/src/main/java/com/alohi/signplus/config/SignplusConfig.java
index 3c0ae4c..b46b0e0 100644
--- a/src/main/java/com/alohi/signplus/config/SignplusConfig.java
+++ b/src/main/java/com/alohi/signplus/config/SignplusConfig.java
@@ -6,13 +6,18 @@
import lombok.NonNull;
import lombok.Setter;
+/**
+ * Configuration class for SDK client settings.
+ * Provides builder pattern for configuring base URLs, authentication, timeouts, and retry behavior.
+ * All configuration options have sensible defaults and can be customized as needed.
+ */
@Builder
@Data
public class SignplusConfig {
@NonNull
@Builder.Default
- private String userAgent = "signplus/1.0.0";
+ private String userAgent = "postman-codegen/1.5.1 signplus/4.0.0 (java)";
@Setter
private String baseUrl;
diff --git a/src/main/java/com/alohi/signplus/http/Environment.java b/src/main/java/com/alohi/signplus/http/Environment.java
index 983c71b..6d91236 100644
--- a/src/main/java/com/alohi/signplus/http/Environment.java
+++ b/src/main/java/com/alohi/signplus/http/Environment.java
@@ -1,10 +1,10 @@
package com.alohi.signplus.http;
import lombok.Getter;
-import okhttp3.HttpUrl;
/**
- * SDK Environments
+ * Predefined environment configurations for the SDK.
+ * Each environment represents a different base URL (e.g., production, staging, development).
*/
@Getter
public enum Environment {
@@ -13,11 +13,6 @@ public enum Environment {
private final String url;
Environment(String url) {
- if (HttpUrl.parse(url) == null) {
- throw new IllegalArgumentException(
- String.format("Environment url [%s] is not valid. Please use the following format https://api.example.com", url)
- );
- }
this.url = url;
}
}
diff --git a/src/main/java/com/alohi/signplus/http/HttpMethod.java b/src/main/java/com/alohi/signplus/http/HttpMethod.java
index 1cc6f4c..134e29c 100644
--- a/src/main/java/com/alohi/signplus/http/HttpMethod.java
+++ b/src/main/java/com/alohi/signplus/http/HttpMethod.java
@@ -3,21 +3,39 @@
import lombok.Getter;
import lombok.RequiredArgsConstructor;
+/**
+ * Enum representing HTTP methods (verbs) used in API requests.
+ * Provides utility methods for determining method characteristics.
+ */
@Getter
@RequiredArgsConstructor
public enum HttpMethod {
+ /** HTTP GET method for retrieving resources */
GET("GET"),
+ /** HTTP POST method for creating resources */
POST("POST"),
+ /** HTTP PUT method for updating/replacing resources */
PUT("PUT"),
+ /** HTTP PATCH method for partially updating resources */
PATCH("PATCH"),
+ /** HTTP DELETE method for removing resources */
DELETE("DELETE"),
+ /** HTTP HEAD method for retrieving headers only */
HEAD("HEAD"),
+ /** HTTP OPTIONS method for describing communication options */
OPTIONS("OPTIONS"),
+ /** HTTP TRACE method for diagnostic purposes */
TRACE("TRACE"),
+ /** HTTP CONNECT method for establishing tunnels */
CONNECT("CONNECT");
private final String method;
+ /**
+ * Determines if this HTTP method requires a request body.
+ *
+ * @return true if POST, PUT, or PATCH; false otherwise
+ */
public boolean requiresRequestBody() {
return method.equals("POST") || method.equals("PUT") || method.equals("PATCH");
}
diff --git a/src/main/java/com/alohi/signplus/http/ModelConverter.java b/src/main/java/com/alohi/signplus/http/ModelConverter.java
index 4cc126f..9474b88 100644
--- a/src/main/java/com/alohi/signplus/http/ModelConverter.java
+++ b/src/main/java/com/alohi/signplus/http/ModelConverter.java
@@ -1,16 +1,29 @@
package com.alohi.signplus.http;
+import com.alohi.signplus.http.util.ContentTypes;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
+import java.lang.reflect.Method;
+import java.nio.charset.StandardCharsets;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import okhttp3.MediaType;
import okhttp3.Response;
import okhttp3.ResponseBody;
import org.openapitools.jackson.nullable.JsonNullableModule;
+/**
+ * Utility class for converting between JSON and Java models.
+ * Uses Jackson ObjectMapper with preconfigured settings for SDK serialization/deserialization.
+ * Handles responses as Class types or TypeReferences with proper error logging.
+ */
public final class ModelConverter {
+ private static final Logger logger = Logger.getLogger(ModelConverter.class.getName());
private static final ObjectMapper mapper = new ObjectMapper();
static {
@@ -27,39 +40,106 @@ public final class ModelConverter {
private ModelConverter() {}
+ /**
+ * Converts an HTTP response body to a Java object of the specified class.
+ *
+ * @param The type of the model class
+ * @param response The HTTP response to convert
+ * @param clazz The target class to deserialize into
+ * @return The deserialized object, or null if conversion fails
+ */
public static T convert(final Response response, final Class clazz) {
- final ResponseBody body = response.body();
try {
- return mapper.readValue(body.string(), clazz);
+ return convert(response.body().bytes(), clazz);
} catch (Exception e) {
- e.printStackTrace();
+ logger.log(Level.SEVERE, "Failed to read response body: " + e.getMessage(), e);
+ return null;
+ }
+ }
+
+ /**
+ * Converts raw byte array to a Java object of the specified class.
+ *
+ * @param The type of the model class
+ * @param bodyBytes The response body as bytes
+ * @param clazz The target class to deserialize into
+ * @return The deserialized object, or null if conversion fails or body is empty
+ */
+ public static T convert(final byte[] bodyBytes, final Class clazz) {
+ try {
+ if (bodyBytes == null || bodyBytes.length == 0) {
+ logger.log(Level.FINE, "Received empty response body, returning null");
+ return null;
+ }
+
+ return mapper.readValue(bodyBytes, clazz);
+ } catch (Exception e) {
+ logger.log(Level.SEVERE, "Failed to read response body: " + e.getMessage(), e);
return null;
}
}
public static T convert(final String response, final Class clazz) {
try {
+ // Handle empty responses
+ if (response == null || response.trim().isEmpty()) {
+ logger.log(Level.FINE, "Received empty response string, returning null");
+ return null;
+ }
return mapper.readValue(response, clazz);
+ } catch (MismatchedInputException e) {
+ logger.log(
+ Level.SEVERE,
+ "Failed to parse response - invalid or malformed JSON: " + e.getMessage(),
+ e
+ );
+ return null;
} catch (Exception e) {
- e.printStackTrace();
+ logger.log(Level.SEVERE, "Unexpected error parsing response: " + e.getMessage(), e);
return null;
}
}
public static T convert(Response response, TypeReference typeReference) {
try {
- return convert(response.body().string(), typeReference);
+ return convert(response.body().bytes(), typeReference);
} catch (Exception e) {
- e.printStackTrace();
+ logger.log(Level.SEVERE, "Failed to read response body: " + e.getMessage(), e);
+ return null;
+ }
+ }
+
+ public static T convert(byte[] bodyBytes, TypeReference typeReference) {
+ try {
+ if (bodyBytes == null || bodyBytes.length == 0) {
+ logger.log(Level.FINE, "Received empty response body, returning null");
+ return null;
+ }
+
+ return mapper.readValue(bodyBytes, typeReference);
+ } catch (Exception e) {
+ logger.log(Level.SEVERE, "Failed to read response body: " + e.getMessage(), e);
return null;
}
}
public static T convert(String response, TypeReference typeReference) {
try {
+ // Handle empty responses
+ if (response == null || response.trim().isEmpty()) {
+ logger.log(Level.FINE, "Received empty response string, returning null");
+ return null;
+ }
return mapper.readValue(response, typeReference);
+ } catch (MismatchedInputException e) {
+ logger.log(
+ Level.SEVERE,
+ "Failed to parse response - invalid or malformed JSON: " + e.getMessage(),
+ e
+ );
+ return null;
} catch (Exception e) {
- e.printStackTrace();
+ logger.log(Level.SEVERE, "Unexpected error parsing response: " + e.getMessage(), e);
return null;
}
}
@@ -68,7 +148,7 @@ public static String readString(Response response) {
try {
return response.body().string();
} catch (Exception e) {
- e.printStackTrace();
+ logger.log(Level.SEVERE, "Failed to read response body as string: " + e.getMessage(), e);
return null;
}
}
@@ -77,17 +157,96 @@ public static byte[] readBytes(Response response) {
try {
return response.body().bytes();
} catch (Exception e) {
- e.printStackTrace();
+ logger.log(Level.SEVERE, "Failed to read response body as bytes: " + e.getMessage(), e);
return null;
}
}
+ public static String toBodyString(byte[] bodyBytes) {
+ try {
+ return new String(bodyBytes, StandardCharsets.UTF_8);
+ } catch (Exception e) {
+ logger.log(Level.SEVERE, "Failed to convert body bytes to string: " + e.getMessage(), e);
+ return "";
+ }
+ }
+
+ /**
+ * Serializes a Java model object to JSON string.
+ *
+ * @param model The model object to serialize
+ * @return The JSON string representation, or null if serialization fails
+ */
public static String modelToJson(final Object model) {
try {
return mapper.writeValueAsString(model);
} catch (Exception e) {
- e.printStackTrace();
+ logger.log(Level.SEVERE, "Failed to serialize model to JSON: " + e.getMessage(), e);
return null;
}
}
+
+ /**
+ * Converts response body bytes to a OneOf type by determining the appropriate factory method
+ * based on the content type and using reflection to invoke it.
+ *
+ * @param The type of the OneOf model class
+ * @param bodyBytes The response body as bytes
+ * @param typeReference The target TypeReference to deserialize into
+ * @param contentType The content type of the response
+ * @return The deserialized object, or null if conversion fails
+ */
+ public static T convertOneOf(
+ final byte[] bodyBytes,
+ final TypeReference typeReference,
+ final MediaType contentType
+ ) {
+ try {
+ String methodName;
+ Class parameterType;
+ Object data;
+
+ if (ContentTypes.isTextual(contentType)) {
+ methodName = "ofString";
+ parameterType = String.class;
+ data = toBodyString(bodyBytes);
+ } else if (ContentTypes.isBinary(contentType)) {
+ methodName = "ofBinary";
+ parameterType = byte[].class;
+ data = bodyBytes;
+ } else {
+ return convert(bodyBytes, typeReference);
+ }
+
+ Class clazz = (Class) typeReference.getType();
+
+ Method method = clazz.getDeclaredMethod(methodName, parameterType);
+ method.setAccessible(true);
+
+ return (T) method.invoke(null, data);
+ } catch (Exception e) {
+ logger.log(Level.SEVERE, "Failed to convert OneOf response: " + e.getMessage(), e);
+ return null;
+ }
+ }
+
+ /**
+ * Converts response body string to a OneOf type by determining the appropriate factory method
+ * based on the content type and using reflection to invoke it.
+ *
+ * @param The type of the OneOf model class
+ * @param body The response body as string
+ * @param typeReference The target TypeReference to deserialize into
+ * @param contentType The content type of the response
+ * @return The deserialized object, or null if conversion fails
+ */
+ public static T convertOneOf(
+ final String body,
+ final TypeReference typeReference,
+ final MediaType contentType
+ ) {
+ byte[] bodyBytes = body.getBytes(StandardCharsets.UTF_8);
+
+ return convertOneOf(bodyBytes, typeReference, contentType);
+ }
}
diff --git a/src/main/java/com/alohi/signplus/http/interceptors/DefaultHeadersInterceptor.java b/src/main/java/com/alohi/signplus/http/interceptors/DefaultHeadersInterceptor.java
index 17b66f8..ab9cc19 100644
--- a/src/main/java/com/alohi/signplus/http/interceptors/DefaultHeadersInterceptor.java
+++ b/src/main/java/com/alohi/signplus/http/interceptors/DefaultHeadersInterceptor.java
@@ -9,19 +9,41 @@
import okhttp3.Request.Builder;
import okhttp3.Response;
+/**
+ * OkHttp interceptor that adds default headers to all requests.
+ * Currently adds the User-Agent header based on SDK configuration.
+ */
public class DefaultHeadersInterceptor implements Interceptor {
private final Map defaultHeaders = new HashMap<>();
+ /**
+ * Constructs a new DefaultHeadersInterceptor.
+ *
+ * @param config The SDK configuration containing default header values
+ */
public DefaultHeadersInterceptor(SignplusConfig config) {
defaultHeaders.put("User-Agent", config.getUserAgent());
}
+ /**
+ * Intercepts a request to add default headers before proceeding.
+ *
+ * @param chain The OkHttp interceptor chain
+ * @return The HTTP response
+ * @throws IOException if an I/O error occurs during request execution
+ */
@Override
public Response intercept(Chain chain) throws IOException {
return chain.proceed(addDefaultHeadersToRequest(chain.request()));
}
+ /**
+ * Adds default headers to a request.
+ *
+ * @param request The HTTP request to modify
+ * @return The modified request with default headers added
+ */
private Request addDefaultHeadersToRequest(Request request) {
if (defaultHeaders.isEmpty()) {
return request;
diff --git a/src/main/java/com/alohi/signplus/http/interceptors/RetryInterceptor.java b/src/main/java/com/alohi/signplus/http/interceptors/RetryInterceptor.java
index 9cf3c8b..bef865e 100644
--- a/src/main/java/com/alohi/signplus/http/interceptors/RetryInterceptor.java
+++ b/src/main/java/com/alohi/signplus/http/interceptors/RetryInterceptor.java
@@ -8,11 +8,23 @@
import okhttp3.Request;
import okhttp3.Response;
+/**
+ * OkHttp interceptor that automatically retries failed HTTP requests.
+ * Supports configurable retry attempts, backoff delays, and specific status codes or exceptions to retry.
+ */
@AllArgsConstructor
public class RetryInterceptor implements Interceptor {
private RetryConfig config;
+ /**
+ * Intercepts an HTTP request and retries it according to the configured retry policy.
+ * Implements exponential backoff between retry attempts.
+ *
+ * @param chain The OkHttp interceptor chain
+ * @return The HTTP response from a successful attempt
+ * @throws IOException if all retry attempts fail or a non-retryable exception occurs
+ */
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
@@ -31,7 +43,10 @@ public Response intercept(Chain chain) throws IOException {
}
tryCount++;
} catch (IOException e) {
- if (!config.getExceptionsToRetry().contains(e.getClass()) || tryCount == config.getMaxRetries()) {
+ if (
+ !config.getExceptionsToRetry().contains(e.getClass()) ||
+ tryCount == config.getMaxRetries()
+ ) {
throw e;
}
}
@@ -48,13 +63,31 @@ public Response intercept(Chain chain) throws IOException {
return response;
}
+ /**
+ * Calculates the delay before the next retry attempt using exponential backoff.
+ *
+ * @param tryCount The current retry attempt number (1-indexed)
+ * @return The delay in milliseconds, capped at the configured maximum delay
+ */
private int calculateDelay(int tryCount) {
- final int delay = (int) (config.getInitialDelay() * Math.pow(config.getBackoffFactor(), tryCount - 1));
+ final int delay = (int) (config.getInitialDelay() *
+ Math.pow(config.getBackoffFactor(), tryCount - 1));
return Math.min(delay, config.getMaxDelay());
}
+ /**
+ * Determines if a response should be retried based on status code and HTTP method.
+ * By default, retries all 5xx server errors and specific 4xx client errors (408 Timeout, 429 Rate Limit).
+ *
+ * @param response The HTTP response to check
+ * @return true if the response should be retried, false otherwise
+ */
private boolean isRetryable(Response response) {
- final boolean isRetryableStatusCode = config.getStatusCodesToRetry().contains(response.code());
+ final int statusCode = response.code();
+ final boolean isRetryableStatusCode = !config.getStatusCodesToRetry().isEmpty()
+ ? config.getStatusCodesToRetry().contains(statusCode)
+ : statusCode >= 500 || statusCode == 408 || statusCode == 429;
+
final boolean isRetryableMethod = config
.getHttpMethodsToRetry()
.stream()
diff --git a/src/main/java/com/alohi/signplus/http/serialization/PathSerializationStyle.java b/src/main/java/com/alohi/signplus/http/serialization/PathSerializationStyle.java
index 82ca9a9..2120022 100644
--- a/src/main/java/com/alohi/signplus/http/serialization/PathSerializationStyle.java
+++ b/src/main/java/com/alohi/signplus/http/serialization/PathSerializationStyle.java
@@ -1,10 +1,18 @@
package com.alohi.signplus.http.serialization;
+/**
+ * Serialization styles supported for path parameters in OpenAPI specifications.
+ * Defines how values are encoded when embedded in URL paths.
+ */
public enum PathSerializationStyle {
+ /** Simple style - comma-separated values (default for path parameters) */
SIMPLE(SerializationStyle.SIMPLE),
+ /** Label style - dot-prefixed values (.value or .id.name) */
LABEL(SerializationStyle.LABEL),
+ /** Matrix style - semicolon-prefixed key-value pairs (;key=value) */
MATRIX(SerializationStyle.MATRIX);
+ /** The underlying serialization style */
public final SerializationStyle style;
PathSerializationStyle(SerializationStyle style) {
diff --git a/src/main/java/com/alohi/signplus/http/serialization/QuerySerializationStyle.java b/src/main/java/com/alohi/signplus/http/serialization/QuerySerializationStyle.java
index 4b58850..0401034 100644
--- a/src/main/java/com/alohi/signplus/http/serialization/QuerySerializationStyle.java
+++ b/src/main/java/com/alohi/signplus/http/serialization/QuerySerializationStyle.java
@@ -1,11 +1,20 @@
package com.alohi.signplus.http.serialization;
+/**
+ * Serialization styles supported for query parameters in OpenAPI specifications.
+ * Defines how values are encoded as URL query strings.
+ */
public enum QuerySerializationStyle {
+ /** Form style - ampersand-separated key-value pairs (default for query parameters) */
FORM(SerializationStyle.FORM),
+ /** Space-delimited style - values separated by spaces (encoded as %20) */
SPACE_DELIMITED(SerializationStyle.SPACE_DELIMITED),
+ /** Pipe-delimited style - values separated by pipe characters (|) */
PIPE_DELIMITED(SerializationStyle.PIPE_DELIMITED),
+ /** Deep object style - nested objects with bracket notation (obj[field]=value) */
DEEP_OBJECT(SerializationStyle.DEEP_OBJECT);
+ /** The underlying serialization style */
public final SerializationStyle style;
QuerySerializationStyle(SerializationStyle style) {
diff --git a/src/main/java/com/alohi/signplus/http/serialization/SerializationStyle.java b/src/main/java/com/alohi/signplus/http/serialization/SerializationStyle.java
index 8ae3e00..db39a31 100644
--- a/src/main/java/com/alohi/signplus/http/serialization/SerializationStyle.java
+++ b/src/main/java/com/alohi/signplus/http/serialization/SerializationStyle.java
@@ -1,11 +1,22 @@
package com.alohi.signplus.http.serialization;
+/**
+ * Enum representing OpenAPI parameter serialization styles.
+ * Defines how parameters are formatted for different parts of HTTP requests.
+ */
public enum SerializationStyle {
+ /** Simple style - comma-separated values (default for path/header parameters) */
SIMPLE,
+ /** Label style - dot-prefixed values for path parameters (.value or .id.name) */
LABEL,
+ /** Matrix style - semicolon-prefixed key-value pairs for path parameters (;key=value) */
MATRIX,
+ /** Form style - ampersand-separated key-value pairs (default for query parameters) */
FORM,
+ /** Space-delimited style - space-separated values for query parameters */
SPACE_DELIMITED,
+ /** Pipe-delimited style - pipe-separated values for query parameters */
PIPE_DELIMITED,
+ /** Deep object style - nested objects with bracket notation (id[key]=value) */
DEEP_OBJECT,
}
diff --git a/src/main/java/com/alohi/signplus/http/serialization/Serializer.java b/src/main/java/com/alohi/signplus/http/serialization/Serializer.java
index 2f13436..4ee6d83 100644
--- a/src/main/java/com/alohi/signplus/http/serialization/Serializer.java
+++ b/src/main/java/com/alohi/signplus/http/serialization/Serializer.java
@@ -4,21 +4,50 @@
import java.util.Map;
import java.util.stream.Collectors;
+/**
+ * Utility class for serializing parameters according to OpenAPI serialization styles.
+ * Supports simple, label, matrix, form, pipe-delimited, space-delimited, and deep object styles.
+ * Handles primitives, strings, lists, and complex objects with proper encoding.
+ */
public class Serializer {
+ /**
+ * Serializes a long value to a string with the specified style and encoding.
+ *
+ * @param key The parameter name
+ * @param value The long value to serialize
+ * @param style The serialization style to use
+ * @param encode Whether to URL-encode the value
+ * @return The serialized parameter string
+ */
public static String serialize(String key, long value, SerializationStyle style, boolean encode) {
return serialize(key, String.valueOf(value), style, encode);
}
- public static String serialize(String key, double value, SerializationStyle style, boolean encode) {
+ public static String serialize(
+ String key,
+ double value,
+ SerializationStyle style,
+ boolean encode
+ ) {
return serialize(key, String.valueOf(value), style, encode);
}
- public static String serialize(String key, boolean value, SerializationStyle style, boolean encode) {
+ public static String serialize(
+ String key,
+ boolean value,
+ SerializationStyle style,
+ boolean encode
+ ) {
return serialize(key, String.valueOf(value), style, encode);
}
- public static String serialize(String key, String value, SerializationStyle style, boolean encode) {
+ public static String serialize(
+ String key,
+ String value,
+ SerializationStyle style,
+ boolean encode
+ ) {
if (value == null) {
value = "null";
}
@@ -35,7 +64,24 @@ public static String serialize(String key, String value, SerializationStyle styl
}
}
- public static String serialize(String key, Object value, SerializationStyle style, boolean explode, boolean encode) {
+ /**
+ * Serializes any object value according to the specified serialization style.
+ * Handles primitives, strings, lists, and complex objects with proper OpenAPI serialization.
+ *
+ * @param key The parameter name
+ * @param value The value to serialize (can be primitive, String, List, or object)
+ * @param style The serialization style to use (SIMPLE, LABEL, MATRIX, FORM, etc.)
+ * @param explode Whether to use exploded form for arrays/objects
+ * @param encode Whether to URL-encode values
+ * @return The serialized parameter string
+ */
+ public static String serialize(
+ String key,
+ Object value,
+ SerializationStyle style,
+ boolean explode,
+ boolean encode
+ ) {
if (value == null) {
return serialize(key, "null", style, encode);
}
@@ -77,7 +123,10 @@ private static String serializeList(
return "";
}
- List serializedValues = value.stream().map(v -> serializeValue(v, encode)).collect(Collectors.toList());
+ List serializedValues = value
+ .stream()
+ .map(v -> serializeValue(v, encode))
+ .collect(Collectors.toList());
switch (style) {
case SIMPLE:
return String.join(",", serializedValues);
@@ -87,7 +136,10 @@ private static String serializeList(
return String.format(".%s", String.join(separator, serializedValues));
case MATRIX:
return explode
- ? serializedValues.stream().map(v -> String.format(";%s=%s", key, v)).collect(Collectors.joining(""))
+ ? serializedValues
+ .stream()
+ .map(v -> String.format(";%s=%s", key, v))
+ .collect(Collectors.joining(""))
: String.format(";%s=", key) + String.join(",", serializedValues);
}
@@ -185,7 +237,22 @@ private static String serializeObject(
}
}
- public static String serializeDeepObject(String key, Object value, boolean topLevel, boolean encode) {
+ /**
+ * Serializes an object using deep object style (e.g., id[key]=value&id[key][deepKey]=deepValue).
+ * Recursively handles nested objects with bracket notation.
+ *
+ * @param key The parameter name
+ * @param value The value to serialize
+ * @param topLevel Whether this is the top-level call (affects bracket notation)
+ * @param encode Whether to URL-encode values
+ * @return The serialized deep object string
+ */
+ public static String serializeDeepObject(
+ String key,
+ Object value,
+ boolean topLevel,
+ boolean encode
+ ) {
if (!Util.isObject(value)) {
return String.format("[%s]=%s", key, serializeValue(value, encode));
}
diff --git a/src/main/java/com/alohi/signplus/http/serialization/Util.java b/src/main/java/com/alohi/signplus/http/serialization/Util.java
index da7d8b2..b29eff0 100644
--- a/src/main/java/com/alohi/signplus/http/serialization/Util.java
+++ b/src/main/java/com/alohi/signplus/http/serialization/Util.java
@@ -12,6 +12,10 @@
import lombok.SneakyThrows;
import org.openapitools.jackson.nullable.JsonNullableModule;
+/**
+ * Utility class for serialization helper methods.
+ * Provides functions for type checking, URL encoding, and property extraction.
+ */
public class Util {
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
@@ -21,8 +25,18 @@ public class Util {
OBJECT_MAPPER.registerModule(new JsonNullableModule());
}
+ /**
+ * Extracts properties from an object using JSON property names.
+ * Uses Jackson annotations to determine the correct property names.
+ *
+ * @param value The object to extract properties from
+ * @return A map of JSON property names to their values
+ */
public static Map getPropertiesWithJsonPropertyNames(Object value) {
- Map properties = OBJECT_MAPPER.convertValue(value, new TypeReference>() {});
+ Map properties = OBJECT_MAPPER.convertValue(
+ value,
+ new TypeReference>() {}
+ );
// Use the json property name if it exists, otherwise use the regular property name
return properties
@@ -43,11 +57,23 @@ public static Map getPropertiesWithJsonPropertyNames(Object valu
);
}
+ /**
+ * URL-encodes a string value using UTF-8 encoding.
+ *
+ * @param value The string to encode
+ * @return The URL-encoded string
+ */
@SneakyThrows
public static String urlEncode(String value) {
return URLEncoder.encode(value, StandardCharsets.UTF_8.toString());
}
+ /**
+ * Checks if a value is a primitive type (number, boolean, string, or character).
+ *
+ * @param value The value to check
+ * @return true if the value is a primitive type, false otherwise
+ */
public static boolean isPrimitive(Object value) {
return (
value instanceof Long ||
@@ -60,6 +86,12 @@ public static boolean isPrimitive(Object value) {
);
}
+ /**
+ * Checks if a value is a complex object (not primitive and not iterable).
+ *
+ * @param value The value to check
+ * @return true if the value is a complex object, false otherwise
+ */
public static boolean isObject(Object value) {
return !isPrimitive(value) && !(value instanceof Iterable);
}
diff --git a/src/main/java/com/alohi/signplus/http/util/ContentTypes.java b/src/main/java/com/alohi/signplus/http/util/ContentTypes.java
new file mode 100644
index 0000000..8bba0f9
--- /dev/null
+++ b/src/main/java/com/alohi/signplus/http/util/ContentTypes.java
@@ -0,0 +1,85 @@
+package com.alohi.signplus.http.util;
+
+import okhttp3.MediaType;
+import okhttp3.Response;
+
+public class ContentTypes {
+
+ private static final MediaType FALLBACK_CONTENT_TYPE = MediaType.parse("application/json");
+
+ /**
+ * Determines if the given MediaType is textual.
+ * In this case, JSON is not considered textual.
+ * @param contentType The MediaType to check
+ * @return true if the content type is textual, false otherwise
+ */
+ public static boolean isTextual(MediaType contentType) {
+ if (contentType == null) {
+ return false;
+ }
+
+ String type = contentType.type();
+ String subtype = contentType.subtype();
+
+ if ("text".equals(type)) {
+ return true;
+ }
+
+ if ("application".equals(type) && (subtype.equals("xml") || subtype.endsWith("+xml"))) {
+ return true;
+ }
+
+ if ("image".equals(type) && "svg+xml".equals(subtype)) {
+ return true;
+ }
+
+ if ("application".equals(type) && "javascript".equals(subtype)) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Determines if the given MediaType is binary.
+ * Binary types include: application/octet-stream, PDFs, images (except svg+xml), and wildcard
+ *
+ * @param contentType The MediaType to check
+ * @return true if the content type is binary, false otherwise
+ */
+ public static boolean isBinary(MediaType contentType) {
+ if (contentType == null) {
+ return false;
+ }
+
+ String type = contentType.type();
+ String subtype = contentType.subtype();
+
+ // wildcard
+ if ("*".equals(type) && "*".equals(subtype)) {
+ return true;
+ }
+
+ if ("application".equals(type) && "octet-stream".equals(subtype)) {
+ return true;
+ }
+
+ if ("application".equals(type) && "pdf".equals(subtype)) {
+ return true;
+ }
+
+ if ("image".equals(type) && !"svg+xml".equals(subtype)) {
+ return true;
+ }
+
+ return false;
+ }
+
+ public static MediaType readContentType(Response response) {
+ if (response.body() != null && response.body().contentType() != null) {
+ return response.body().contentType();
+ }
+
+ return FALLBACK_CONTENT_TYPE;
+ }
+}
diff --git a/src/main/java/com/alohi/signplus/http/util/HttpArgumentConverter.java b/src/main/java/com/alohi/signplus/http/util/HttpArgumentConverter.java
index bc88221..f44ce82 100644
--- a/src/main/java/com/alohi/signplus/http/util/HttpArgumentConverter.java
+++ b/src/main/java/com/alohi/signplus/http/util/HttpArgumentConverter.java
@@ -21,12 +21,20 @@ public static String toStringArgument(final Object value) {
if (value == null) {
return "";
}
- if (value instanceof String || value instanceof Number || value instanceof Boolean || value instanceof Enum) {
+ if (
+ value instanceof String ||
+ value instanceof Number ||
+ value instanceof Boolean ||
+ value instanceof Enum
+ ) {
return String.valueOf(value);
}
if (value instanceof List) {
List list = (List) value;
- return list.stream().map(HttpArgumentConverter::toStringArgument).collect(Collectors.joining(","));
+ return list
+ .stream()
+ .map(HttpArgumentConverter::toStringArgument)
+ .collect(Collectors.joining(","));
}
return modelToJson(value);
diff --git a/src/main/java/com/alohi/signplus/http/util/RequestBuilder.java b/src/main/java/com/alohi/signplus/http/util/RequestBuilder.java
index 5027ea6..656044f 100644
--- a/src/main/java/com/alohi/signplus/http/util/RequestBuilder.java
+++ b/src/main/java/com/alohi/signplus/http/util/RequestBuilder.java
@@ -6,7 +6,12 @@
import com.alohi.signplus.http.serialization.QuerySerializationStyle;
import com.alohi.signplus.http.serialization.SerializationStyle;
import com.alohi.signplus.http.serialization.Serializer;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
import lombok.NonNull;
import okhttp3.HttpUrl;
import okhttp3.MediaType;
@@ -14,6 +19,11 @@
import okhttp3.RequestBody;
import org.jetbrains.annotations.NotNull;
+/**
+ * Fluent builder for constructing OkHttp Request objects with SDK-specific features.
+ * Handles path/query parameter serialization, header management, authentication,
+ * and request body construction according to OpenAPI serialization styles.
+ */
public class RequestBuilder {
@NonNull
@@ -31,6 +41,8 @@ public class RequestBuilder {
private final HashMap headers = new HashMap<>();
+ private final List cookies = new ArrayList<>();
+
private RequestBody body;
/**
@@ -39,21 +51,37 @@ public class RequestBuilder {
* @param path The path template to use for the request. Should have path parameters as
* placeholders surrounded by brackets (Eg. "/users/{id}", where "id" is a path parameter).
*/
- public RequestBuilder(@NotNull HttpMethod httpMethod, @NotNull String baseUrl, @NotNull String path) {
+ public RequestBuilder(
+ @NotNull HttpMethod httpMethod,
+ @NotNull String baseUrl,
+ @NotNull String path
+ ) {
this.httpMethod = httpMethod;
this.baseUrl = baseUrl;
this.path = path;
}
/**
- * Sets a path parameter. If the parameter is not present in the URL template, it will be ignored.
+ * Sets a path parameter using the default SIMPLE serialization style.
+ * If the parameter is not present in the URL template, it will be ignored.
+ *
+ * @param key The path parameter name
+ * @param value The parameter value
+ * @return This builder instance for chaining
*/
public RequestBuilder setPathParameter(@NonNull String key, @NonNull Object value) {
return setPathParameter(key, value, PathSerializationStyle.SIMPLE, false);
}
/**
- * Sets a path parameter. If the parameter is not present in the URL template, it will be ignored.
+ * Sets a path parameter with custom serialization style and explode option.
+ * If the parameter is not present in the URL template, it will be ignored.
+ *
+ * @param key The path parameter name
+ * @param value The parameter value
+ * @param style The serialization style to use
+ * @param explode Whether to explode arrays/objects into separate values
+ * @return This builder instance for chaining
*/
public RequestBuilder setPathParameter(
@NonNull String key,
@@ -67,14 +95,24 @@ public RequestBuilder setPathParameter(
}
/**
- * Sets a query parameter.
+ * Sets a query parameter using the default FORM serialization style with explode enabled.
+ *
+ * @param key The query parameter name
+ * @param value The parameter value
+ * @return This builder instance for chaining
*/
public RequestBuilder setQueryParameter(@NonNull String key, @NonNull Object value) {
return setQueryParameter(key, value, QuerySerializationStyle.FORM, true);
}
/**
- * Sets a query parameter.
+ * Sets a query parameter with custom serialization style and explode option.
+ *
+ * @param key The query parameter name
+ * @param value The parameter value
+ * @param style The serialization style to use
+ * @param explode Whether to explode arrays/objects into separate parameters
+ * @return This builder instance for chaining
*/
public RequestBuilder setQueryParameter(
@NonNull String key,
@@ -87,12 +125,25 @@ public RequestBuilder setQueryParameter(
return this;
}
+ /**
+ * Sets a query parameter using the default FORM style if the value is not null.
+ *
+ * @param key The query parameter name
+ * @param value The parameter value (ignored if null)
+ * @return This builder instance for chaining
+ */
public RequestBuilder setOptionalQueryParameter(@NonNull String key, Object value) {
return setOptionalQueryParameter(key, value, QuerySerializationStyle.FORM, true);
}
/**
- * Sets a query parameter if the value is not null.
+ * Sets a query parameter with custom serialization if the value is not null.
+ *
+ * @param key The query parameter name
+ * @param value The parameter value (ignored if null)
+ * @param style The serialization style to use
+ * @param explode Whether to explode arrays/objects into separate parameters
+ * @return This builder instance for chaining
*/
public RequestBuilder setOptionalQueryParameter(
@NonNull String key,
@@ -107,30 +158,54 @@ public RequestBuilder setOptionalQueryParameter(
}
/**
- * Sets a header.
+ * Sets a header using SIMPLE serialization style without explode.
+ *
+ * @param key The header name
+ * @param value The header value
+ * @return This builder instance for chaining
*/
public RequestBuilder setHeader(@NonNull String key, @NonNull Object value) {
return setHeader(key, value, false);
}
/**
- * Sets a header.
+ * Sets a header using SIMPLE serialization style with custom explode option.
+ *
+ * @param key The header name
+ * @param value The header value
+ * @param explode Whether to explode arrays/objects
+ * @return This builder instance for chaining
*/
public RequestBuilder setHeader(@NonNull String key, @NonNull Object value, boolean explode) {
- String serializedValue = Serializer.serialize(key, value, SerializationStyle.SIMPLE, explode, false);
+ String serializedValue = Serializer.serialize(
+ key,
+ value,
+ SerializationStyle.SIMPLE,
+ explode,
+ false
+ );
headers.put(key, serializedValue);
return this;
}
/**
- * Sets a header if the value is not null.
+ * Sets a header if the value is not null, using SIMPLE style without explode.
+ *
+ * @param key The header name
+ * @param value The header value (ignored if null)
+ * @return This builder instance for chaining
*/
public RequestBuilder setOptionalHeader(@NonNull String key, Object value) {
return setOptionalHeader(key, value, false);
}
/**
- * Sets a header if the value is not null.
+ * Sets a header if the value is not null, with custom explode option.
+ *
+ * @param key The header name
+ * @param value The header value (ignored if null)
+ * @param explode Whether to explode arrays/objects
+ * @return This builder instance for chaining
*/
public RequestBuilder setOptionalHeader(@NonNull String key, Object value, boolean explode) {
if (value != null) {
@@ -140,7 +215,73 @@ public RequestBuilder setOptionalHeader(@NonNull String key, Object value, boole
}
/**
- * Sets the body of the request.
+ * Adds a cookie parameter using FORM serialization style with explode enabled.
+ * Multiple cookies are combined into a single Cookie header at build time.
+ *
+ * @param key The cookie name
+ * @param value The cookie value
+ * @return This builder instance for chaining
+ */
+ public RequestBuilder setCookie(@NonNull String key, @NonNull Object value) {
+ return setCookie(key, value, true);
+ }
+
+ /**
+ * Adds a cookie parameter using FORM serialization style with custom explode option.
+ * Multiple cookies are combined into a single Cookie header at build time.
+ *
+ * @param key The cookie name
+ * @param value The cookie value
+ * @param explode Whether to explode arrays/objects
+ * @return This builder instance for chaining
+ */
+ public RequestBuilder setCookie(@NonNull String key, @NonNull Object value, boolean explode) {
+ String serializedValue = Serializer.serialize(
+ key,
+ value,
+ SerializationStyle.FORM,
+ explode,
+ false
+ );
+ if (explode && serializedValue.contains("&")) {
+ Collections.addAll(cookies, serializedValue.split("&"));
+ } else {
+ cookies.add(serializedValue);
+ }
+ return this;
+ }
+
+ /**
+ * Adds a cookie parameter if the value is not null, using FORM style with explode enabled.
+ *
+ * @param key The cookie name
+ * @param value The cookie value (ignored if null)
+ * @return This builder instance for chaining
+ */
+ public RequestBuilder setOptionalCookie(@NonNull String key, Object value) {
+ return setOptionalCookie(key, value, true);
+ }
+
+ /**
+ * Adds a cookie parameter if the value is not null, with custom explode option.
+ *
+ * @param key The cookie name
+ * @param value The cookie value (ignored if null)
+ * @param explode Whether to explode arrays/objects
+ * @return This builder instance for chaining
+ */
+ public RequestBuilder setOptionalCookie(@NonNull String key, Object value, boolean explode) {
+ if (value != null) {
+ return setCookie(key, value, explode);
+ }
+ return this;
+ }
+
+ /**
+ * Sets the raw request body.
+ *
+ * @param body The request body
+ * @return This builder instance for chaining
*/
public RequestBuilder setBody(RequestBody body) {
this.body = body;
@@ -148,25 +289,37 @@ public RequestBuilder setBody(RequestBody body) {
}
/**
- * Sets the content of the request as JSON.
+ * Sets the request body as JSON using the default application/json media type.
+ *
+ * @param content The object to serialize as JSON
+ * @return This builder instance for chaining
*/
public RequestBuilder setJsonContent(Object content) {
return setJsonContent(content, MediaType.parse("application/json; charset=utf-8"));
}
/**
- * Sets the content of the request as JSON.
+ * Sets the request body as JSON with a custom media type.
+ *
+ * @param content The object to serialize as JSON
+ * @param mediaType The media type to use
+ * @return This builder instance for chaining
*/
public RequestBuilder setJsonContent(Object content, MediaType mediaType) {
if (content == null) {
return this;
}
- setBody(RequestBody.create(Objects.requireNonNull(ModelConverter.modelToJson(content)), mediaType));
+ setBody(
+ RequestBody.create(Objects.requireNonNull(ModelConverter.modelToJson(content)), mediaType)
+ );
return this;
}
- /*
+ /**
* Sets the access token authentication header with a "Bearer" prefix.
+ *
+ * @param token The access token
+ * @return This builder instance for chaining
*/
public RequestBuilder setAccessTokenAuth(String token) {
if (token == null) {
@@ -175,8 +328,12 @@ public RequestBuilder setAccessTokenAuth(String token) {
return setAccessTokenAuth(token, "Bearer");
}
- /*
+ /**
* Sets the access token authentication header with a custom prefix.
+ *
+ * @param token The access token
+ * @param prefix The authorization prefix (e.g., "Bearer", "Token")
+ * @return This builder instance for chaining
*/
public RequestBuilder setAccessTokenAuth(String token, String prefix) {
if (token == null || prefix == null) {
@@ -186,7 +343,10 @@ public RequestBuilder setAccessTokenAuth(String token, String prefix) {
}
/**
- * @return The {@code Request} instance.
+ * Builds and returns the configured OkHttp Request instance.
+ * Applies all path parameters, query parameters, headers, and body to create the final request.
+ *
+ * @return The configured Request instance ready to execute
*/
public Request build() {
String url = buildUrl();
@@ -196,6 +356,10 @@ public Request build() {
requestBuilder.addHeader(entry.getKey(), entry.getValue());
}
+ if (!cookies.isEmpty()) {
+ requestBuilder.addHeader("Cookie", String.join("; ", cookies));
+ }
+
if (httpMethod.requiresRequestBody() && this.body == null) {
this.body = RequestBody.create(new byte[0]);
}
@@ -205,6 +369,11 @@ public Request build() {
return requestBuilder.build();
}
+ /**
+ * Constructs the full URL by combining base URL, path, path parameters, and query parameters.
+ *
+ * @return The complete URL string
+ */
private String buildUrl() {
String path = this.path;
@@ -214,7 +383,11 @@ private String buildUrl() {
path = path.replace("{" + key + "}", value);
}
- String url = Objects.requireNonNull(HttpUrl.parse(baseUrl)).newBuilder().addPathSegments(path).build().toString();
+ String url = Objects.requireNonNull(HttpUrl.parse(baseUrl))
+ .newBuilder()
+ .addPathSegments(path)
+ .build()
+ .toString();
if (!queryParameters.isEmpty()) {
url += "?" + String.join("&", queryParameters);
diff --git a/src/main/java/com/alohi/signplus/json/TypeUtils.java b/src/main/java/com/alohi/signplus/json/TypeUtils.java
index 86b31a8..1871304 100644
--- a/src/main/java/com/alohi/signplus/json/TypeUtils.java
+++ b/src/main/java/com/alohi/signplus/json/TypeUtils.java
@@ -5,8 +5,18 @@
import java.util.ArrayList;
import java.util.List;
+/**
+ * Utility methods for type handling and reflection operations in JSON serialization.
+ * Provides helpers for extracting JSON property names and creating generic lists.
+ */
public class TypeUtils {
+ /**
+ * Extracts the JSON property name from a field, using the @JsonProperty annotation if present.
+ *
+ * @param type The field to extract the name from
+ * @return The JSON property name (from annotation) or the field name
+ */
public static String getJsonPropertyName(Field type) {
JsonProperty annotation = type.getAnnotation(JsonProperty.class);
if (annotation != null) {
@@ -15,6 +25,15 @@ public static String getJsonPropertyName(Field type) {
return type.getName();
}
+ /**
+ * Creates a generic list with type safety from an array of objects.
+ * Used for deserializing JSON arrays to strongly-typed Java lists.
+ *
+ * @param The element type of the list
+ * @param type The class of the element type
+ * @param params The objects to add to the list
+ * @return A typed list containing the provided elements
+ */
public static List createGenericList(Class type, Object... params) {
List list = new ArrayList<>();
for (Object param : params) {
diff --git a/src/main/java/com/alohi/signplus/models/AnnotationType.java b/src/main/java/com/alohi/signplus/models/AnnotationType.java
index aa86803..8c14317 100644
--- a/src/main/java/com/alohi/signplus/models/AnnotationType.java
+++ b/src/main/java/com/alohi/signplus/models/AnnotationType.java
@@ -23,6 +23,9 @@ public enum AnnotationType {
@JsonCreator
public static AnnotationType fromValue(String value) {
- return Arrays.stream(AnnotationType.values()).filter(item -> item.value.equals(value)).findFirst().orElse(null);
+ return Arrays.stream(AnnotationType.values())
+ .filter(item -> item.value.equals(value))
+ .findFirst()
+ .orElse(null);
}
}
diff --git a/src/main/java/com/alohi/signplus/models/AttachmentPlaceholdersPerRecipient.java b/src/main/java/com/alohi/signplus/models/AttachmentPlaceholdersPerRecipient.java
index a3307b4..b65fa2b 100644
--- a/src/main/java/com/alohi/signplus/models/AttachmentPlaceholdersPerRecipient.java
+++ b/src/main/java/com/alohi/signplus/models/AttachmentPlaceholdersPerRecipient.java
@@ -77,7 +77,9 @@ public AttachmentPlaceholdersPerRecipientBuilder recipientName(String value) {
private JsonNullable> placeholders = JsonNullable.undefined();
@JsonProperty("placeholders")
- public AttachmentPlaceholdersPerRecipientBuilder placeholders(List value) {
+ public AttachmentPlaceholdersPerRecipientBuilder placeholders(
+ List value
+ ) {
if (value == null) {
throw new IllegalStateException("placeholders cannot be null");
}
diff --git a/src/main/java/com/alohi/signplus/models/EnvelopeAttachments.java b/src/main/java/com/alohi/signplus/models/EnvelopeAttachments.java
index 2a6255f..4f91ce9 100644
--- a/src/main/java/com/alohi/signplus/models/EnvelopeAttachments.java
+++ b/src/main/java/com/alohi/signplus/models/EnvelopeAttachments.java
@@ -49,7 +49,8 @@ public EnvelopeAttachmentsBuilder settings(AttachmentSettings value) {
return this;
}
- private JsonNullable> recipients = JsonNullable.undefined();
+ private JsonNullable> recipients =
+ JsonNullable.undefined();
@JsonProperty("recipients")
public EnvelopeAttachmentsBuilder recipients(List value) {
diff --git a/src/main/java/com/alohi/signplus/models/EnvelopeFlowType.java b/src/main/java/com/alohi/signplus/models/EnvelopeFlowType.java
index 5b4a176..0b5fce8 100644
--- a/src/main/java/com/alohi/signplus/models/EnvelopeFlowType.java
+++ b/src/main/java/com/alohi/signplus/models/EnvelopeFlowType.java
@@ -20,6 +20,9 @@ public enum EnvelopeFlowType {
@JsonCreator
public static EnvelopeFlowType fromValue(String value) {
- return Arrays.stream(EnvelopeFlowType.values()).filter(item -> item.value.equals(value)).findFirst().orElse(null);
+ return Arrays.stream(EnvelopeFlowType.values())
+ .filter(item -> item.value.equals(value))
+ .findFirst()
+ .orElse(null);
}
}
diff --git a/src/main/java/com/alohi/signplus/models/EnvelopeOrderField.java b/src/main/java/com/alohi/signplus/models/EnvelopeOrderField.java
index c540b7b..797264e 100644
--- a/src/main/java/com/alohi/signplus/models/EnvelopeOrderField.java
+++ b/src/main/java/com/alohi/signplus/models/EnvelopeOrderField.java
@@ -23,6 +23,9 @@ public enum EnvelopeOrderField {
@JsonCreator
public static EnvelopeOrderField fromValue(String value) {
- return Arrays.stream(EnvelopeOrderField.values()).filter(item -> item.value.equals(value)).findFirst().orElse(null);
+ return Arrays.stream(EnvelopeOrderField.values())
+ .filter(item -> item.value.equals(value))
+ .findFirst()
+ .orElse(null);
}
}
diff --git a/src/main/java/com/alohi/signplus/models/EnvelopeStatus.java b/src/main/java/com/alohi/signplus/models/EnvelopeStatus.java
index a071370..5c54f1d 100644
--- a/src/main/java/com/alohi/signplus/models/EnvelopeStatus.java
+++ b/src/main/java/com/alohi/signplus/models/EnvelopeStatus.java
@@ -25,6 +25,9 @@ public enum EnvelopeStatus {
@JsonCreator
public static EnvelopeStatus fromValue(String value) {
- return Arrays.stream(EnvelopeStatus.values()).filter(item -> item.value.equals(value)).findFirst().orElse(null);
+ return Arrays.stream(EnvelopeStatus.values())
+ .filter(item -> item.value.equals(value))
+ .findFirst()
+ .orElse(null);
}
}
diff --git a/src/main/java/com/alohi/signplus/models/RecipientRole.java b/src/main/java/com/alohi/signplus/models/RecipientRole.java
index 5990433..509dbb9 100644
--- a/src/main/java/com/alohi/signplus/models/RecipientRole.java
+++ b/src/main/java/com/alohi/signplus/models/RecipientRole.java
@@ -21,6 +21,9 @@ public enum RecipientRole {
@JsonCreator
public static RecipientRole fromValue(String value) {
- return Arrays.stream(RecipientRole.values()).filter(item -> item.value.equals(value)).findFirst().orElse(null);
+ return Arrays.stream(RecipientRole.values())
+ .filter(item -> item.value.equals(value))
+ .findFirst()
+ .orElse(null);
}
}
diff --git a/src/main/java/com/alohi/signplus/models/TemplateOrderField.java b/src/main/java/com/alohi/signplus/models/TemplateOrderField.java
index 7758ebf..a6b4e04 100644
--- a/src/main/java/com/alohi/signplus/models/TemplateOrderField.java
+++ b/src/main/java/com/alohi/signplus/models/TemplateOrderField.java
@@ -22,6 +22,9 @@ public enum TemplateOrderField {
@JsonCreator
public static TemplateOrderField fromValue(String value) {
- return Arrays.stream(TemplateOrderField.values()).filter(item -> item.value.equals(value)).findFirst().orElse(null);
+ return Arrays.stream(TemplateOrderField.values())
+ .filter(item -> item.value.equals(value))
+ .findFirst()
+ .orElse(null);
}
}
diff --git a/src/main/java/com/alohi/signplus/models/WebhookEvent.java b/src/main/java/com/alohi/signplus/models/WebhookEvent.java
index 9398e6e..4306662 100644
--- a/src/main/java/com/alohi/signplus/models/WebhookEvent.java
+++ b/src/main/java/com/alohi/signplus/models/WebhookEvent.java
@@ -23,6 +23,9 @@ public enum WebhookEvent {
@JsonCreator
public static WebhookEvent fromValue(String value) {
- return Arrays.stream(WebhookEvent.values()).filter(item -> item.value.equals(value)).findFirst().orElse(null);
+ return Arrays.stream(WebhookEvent.values())
+ .filter(item -> item.value.equals(value))
+ .findFirst()
+ .orElse(null);
}
}
diff --git a/src/main/java/com/alohi/signplus/services/BaseService.java b/src/main/java/com/alohi/signplus/services/BaseService.java
index eb02e64..e14c8bb 100644
--- a/src/main/java/com/alohi/signplus/services/BaseService.java
+++ b/src/main/java/com/alohi/signplus/services/BaseService.java
@@ -1,18 +1,23 @@
package com.alohi.signplus.services;
+import com.alohi.signplus.config.RequestConfig;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.exceptions.ApiError;
import com.alohi.signplus.http.Environment;
import com.alohi.signplus.http.ModelConverter;
+import com.alohi.signplus.http.interceptors.RetryInterceptor;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.net.SocketTimeoutException;
+import java.util.ArrayList;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;
import okhttp3.Call;
@@ -22,13 +27,27 @@
import okhttp3.Response;
import org.jetbrains.annotations.NotNull;
+/**
+ * Base service class that all API service classes extend.
+ * Provides common functionality including HTTP request execution, error handling,
+ * and configuration management.
+ */
public class BaseService {
private static final Logger logger = Logger.getLogger(BaseService.class.getName());
protected OkHttpClient httpClient;
protected SignplusConfig config;
protected Map> errorMappings;
+ protected ErrorMapping defaultErrorMapping;
+ /** Service-level configuration overrides */
+ protected RequestConfig serviceConfig;
+
+ /**
+ * Internal class for mapping HTTP status codes to error models and exception types.
+ *
+ * @param The error model type
+ */
private static class ErrorMapping {
private final Class modelClass;
@@ -40,24 +59,178 @@ public ErrorMapping(Class modelClass, Class exceptionClas
}
}
+ /**
+ * Constructs a new BaseService instance.
+ *
+ * @param httpClient The HTTP client to use for making requests
+ * @param config The SDK configuration
+ */
public BaseService(OkHttpClient httpClient, SignplusConfig config) {
this.httpClient = httpClient;
this.config = config;
this.errorMappings = new HashMap<>();
}
+ /**
+ * Sets the base URL for API requests.
+ *
+ * @param baseUrl The base URL to use
+ */
public void setBaseUrl(String baseUrl) {
this.config.setBaseUrl(baseUrl);
}
+ /**
+ * Sets the environment for API requests.
+ *
+ * @param environment The environment to use (e.g., DEFAULT, PRODUCTION, STAGING)
+ */
public void setEnvironment(Environment environment) {
this.config.setEnvironment(environment);
}
- protected void addErrorMapping(int status, Class modelClass, Class exceptionClass) {
+ /**
+ * Sets service-level configuration that applies to all methods in this service.
+ * Service-level overrides take precedence over SDK-level configuration but are
+ * overridden by method-level and request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the service level
+ */
+ public void setConfig(RequestConfig config) {
+ this.serviceConfig = config;
+ }
+
+ /**
+ * Resolves configuration from the hierarchy: requestConfig > methodConfig > serviceConfig.
+ * Merges override configs into a single {@link RequestConfig}. SDK defaults are used as
+ * fallbacks where these overrides are not provided.
+ *
+ * @param methodConfig Method-level configuration override (may be null)
+ * @param requestConfig Request-level configuration override (may be null)
+ * @return Merged configuration with all overrides applied
+ */
+ protected RequestConfig getResolvedConfig(
+ RequestConfig methodConfig,
+ RequestConfig requestConfig
+ ) {
+ return RequestConfig.merge(this.serviceConfig, methodConfig, requestConfig);
+ }
+
+ /**
+ * Resolves the base URL from the configuration hierarchy.
+ * Priority: resolvedConfig.baseUrl > sdkConfig.baseUrl > resolvedConfig.environment > defaultEnvironment.
+ *
+ * @param resolvedConfig The merged request configuration (may be null)
+ * @param defaultEnvironment The default environment for this method
+ * @return The resolved base URL
+ */
+ protected String resolveBaseUrl(RequestConfig resolvedConfig, Environment defaultEnvironment) {
+ if (resolvedConfig != null && resolvedConfig.getBaseUrl() != null) {
+ return resolvedConfig.getBaseUrl();
+ }
+ if (this.config.getBaseUrl() != null) {
+ return this.config.getBaseUrl();
+ }
+ if (resolvedConfig != null && resolvedConfig.getEnvironment() != null) {
+ return resolvedConfig.getEnvironment().getUrl();
+ }
+ return defaultEnvironment.getUrl();
+ }
+
+ /**
+ * Resolves the access token from the configuration hierarchy.
+ *
+ * @param resolvedConfig The merged request configuration (may be null)
+ * @return The resolved access token
+ */
+ protected String resolveAccessToken(RequestConfig resolvedConfig) {
+ if (resolvedConfig != null && resolvedConfig.getAccessToken() != null) {
+ return resolvedConfig.getAccessToken();
+ }
+ return this.config.getAccessToken();
+ }
+
+ /**
+ * Creates an OkHttpClient with per-request overrides from the resolved configuration.
+ * Applies timeout and/or retry config overrides when present.
+ * If no overrides are present, returns the original client.
+ *
+ * @param resolvedConfig The resolved request configuration
+ * @return An OkHttpClient with the appropriate overrides applied
+ */
+ protected OkHttpClient getHttpClientForRequest(RequestConfig resolvedConfig) {
+ if (resolvedConfig == null) {
+ return this.httpClient;
+ }
+
+ boolean needsRebuild = resolvedConfig.getTimeout() != null;
+ needsRebuild = needsRebuild || resolvedConfig.getRetryConfig() != null;
+
+ if (!needsRebuild) {
+ return this.httpClient;
+ }
+
+ OkHttpClient.Builder builder = this.httpClient.newBuilder();
+
+ if (resolvedConfig.getTimeout() != null) {
+ builder.readTimeout(resolvedConfig.getTimeout(), TimeUnit.MILLISECONDS);
+ }
+
+ if (resolvedConfig.getRetryConfig() != null) {
+ List interceptors = new ArrayList<>(builder.interceptors());
+ interceptors.replaceAll(i ->
+ i instanceof RetryInterceptor ? new RetryInterceptor(resolvedConfig.getRetryConfig()) : i
+ );
+ builder.interceptors().clear();
+ interceptors.forEach(builder::addInterceptor);
+ }
+
+ return builder.build();
+ }
+
+ /**
+ * Registers an error mapping for a specific HTTP status code.
+ * When a response with this status is received, the SDK will deserialize the error
+ * response to the specified model class and throw the specified exception type.
+ *
+ * @param The error model type
+ * @param status The HTTP status code to map
+ * @param modelClass The class to deserialize the error response into
+ * @param exceptionClass The exception class to throw
+ */
+ protected void addErrorMapping(
+ int status,
+ Class modelClass,
+ Class exceptionClass
+ ) {
this.errorMappings.put(status, new ErrorMapping<>(modelClass, exceptionClass));
}
+ /**
+ * Registers a default error mapping for unmapped HTTP status codes.
+ * When a response with an unmapped status is received the SDK will deserialize the error
+ * response to the specified model class and throw the specified exception type.
+ *
+ * @param The error model type
+ * @param modelClass The class to deserialize the error response into
+ * @param exceptionClass The exception class to throw
+ */
+ protected void addDefaultErrorMapping(
+ Class modelClass,
+ Class exceptionClass
+ ) {
+ this.defaultErrorMapping = new ErrorMapping<>(modelClass, exceptionClass);
+ }
+
+ /**
+ * Extracts an error message from a response and optional error model.
+ * Attempts to get the message from the error model's getMessage() method,
+ * falls back to the response message, or constructs a message from the status code and URL.
+ *
+ * @param response The HTTP response
+ * @param errorModel The deserialized error model (may be null)
+ * @return The extracted or constructed error message
+ */
private String extractErrorMessage(Response response, Object errorModel) {
String message = null;
@@ -74,16 +247,30 @@ private String extractErrorMessage(Response response, Object errorModel) {
}
if (Objects.isNull(message) || message.trim().isEmpty()) {
- message = String.format("%d error in request to: %s", response.code(), response.request().url());
+ message = String.format(
+ "%d error in request to: %s",
+ response.code(),
+ response.request().url()
+ );
}
return message;
}
- protected Response execute(Request request) throws ApiError {
+ /**
+ * Executes an HTTP request synchronously.
+ * Handles error responses by checking error mappings and throwing appropriate exceptions.
+ *
+ * @param request The HTTP request to execute
+ * @param resolvedConfig The resolved request configuration (may contain timeout override)
+ * @return The HTTP response if successful
+ * @throws ApiError if the request fails or returns an error status code
+ */
+ protected Response execute(Request request, RequestConfig resolvedConfig) throws ApiError {
+ OkHttpClient client = this.getHttpClientForRequest(resolvedConfig);
Response response;
try {
- response = this.httpClient.newCall(request).execute();
+ response = client.newCall(request).execute();
} catch (IOException e) {
if (e instanceof SocketTimeoutException) {
throw new ApiError("Request timed out", 408, null);
@@ -96,13 +283,18 @@ protected Response execute(Request request) throws ApiError {
}
// Handle error response
- ErrorMapping errorMapping = this.errorMappings.get(response.code());
+ ErrorMapping errorMapping =
+ this.errorMappings.getOrDefault(response.code(), this.defaultErrorMapping);
if (errorMapping != null) {
Object errorModel = null;
try {
errorModel = ModelConverter.convert(response, errorMapping.modelClass);
} catch (Exception e) {
- logger.log(Level.WARNING, "Failed to deserialize error response to " + errorMapping.modelClass.getName(), e);
+ logger.log(
+ Level.WARNING,
+ "Failed to deserialize error response to " + errorMapping.modelClass.getName(),
+ e
+ );
}
if (errorModel != null) {
@@ -129,9 +321,24 @@ protected Response execute(Request request) throws ApiError {
throw new ApiError(extractErrorMessage(response, null), response.code(), response);
}
- protected CompletableFuture executeAsync(Request request) {
+ /**
+ * Executes an HTTP request asynchronously.
+ * Returns a CompletableFuture that completes with the response or completes exceptionally
+ * if an error occurs. Handles error responses by checking error mappings.
+ *
+ * @param request The HTTP request to execute
+ * @param resolvedConfig The resolved request configuration (may contain timeout override)
+ * @return A CompletableFuture that completes with the HTTP response
+ */
+ protected CompletableFuture executeAsync(
+ Request request,
+ RequestConfig resolvedConfig
+ ) {
+ OkHttpClient client = this.getHttpClientForRequest(resolvedConfig);
CompletableFuture future = new CompletableFuture<>();
- this.httpClient.newCall(request).enqueue(
+ client
+ .newCall(request)
+ .enqueue(
new Callback() {
@Override
public void onResponse(@NotNull Call call, @NotNull Response response) {
@@ -143,12 +350,13 @@ public void onResponse(@NotNull Call call, @NotNull Response response) {
Object errorModel = ModelConverter.convert(response, errorMapping.modelClass);
if (errorModel != null) {
// Use reflection to create the exception
- Constructor constructor = errorMapping.exceptionClass.getConstructor(
- errorMapping.modelClass,
- String.class,
- int.class,
- Response.class
- );
+ Constructor constructor =
+ errorMapping.exceptionClass.getConstructor(
+ errorMapping.modelClass,
+ String.class,
+ int.class,
+ Response.class
+ );
String message = extractErrorMessage(response, errorModel);
future.completeExceptionally(
constructor.newInstance(errorModel, message, response.code(), response)
@@ -165,7 +373,11 @@ public void onResponse(@NotNull Call call, @NotNull Response response) {
}
// If no specific error model is mapped or conversion failed, throw generic ApiError
- ApiError error = new ApiError(extractErrorMessage(response, null), response.code(), response);
+ ApiError error = new ApiError(
+ extractErrorMessage(response, null),
+ response.code(),
+ response
+ );
future.completeExceptionally(error);
return;
}
diff --git a/src/main/java/com/alohi/signplus/services/SignplusService.java b/src/main/java/com/alohi/signplus/services/SignplusService.java
index 9c5f450..5290d0f 100644
--- a/src/main/java/com/alohi/signplus/services/SignplusService.java
+++ b/src/main/java/com/alohi/signplus/services/SignplusService.java
@@ -1,5 +1,6 @@
package com.alohi.signplus.services;
+import com.alohi.signplus.config.RequestConfig;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.exceptions.ApiError;
import com.alohi.signplus.http.Environment;
@@ -65,10 +66,689 @@
*/
public class SignplusService extends BaseService {
+ private RequestConfig createEnvelopeConfig;
+ private RequestConfig createEnvelopeFromTemplateConfig;
+ private RequestConfig listEnvelopesConfig;
+ private RequestConfig getEnvelopeConfig;
+ private RequestConfig deleteEnvelopeConfig;
+ private RequestConfig downloadEnvelopeSignedDocumentsConfig;
+ private RequestConfig downloadEnvelopeCertificateConfig;
+ private RequestConfig getEnvelopeDocumentConfig;
+ private RequestConfig getEnvelopeDocumentsConfig;
+ private RequestConfig addEnvelopeDocumentConfig;
+ private RequestConfig setEnvelopeDynamicFieldsConfig;
+ private RequestConfig addEnvelopeSigningStepsConfig;
+ private RequestConfig setEnvelopeAttachmentsSettingsConfig;
+ private RequestConfig setEnvelopeAttachmentsPlaceholdersConfig;
+ private RequestConfig getAttachmentFileConfig;
+ private RequestConfig sendEnvelopeConfig;
+ private RequestConfig duplicateEnvelopeConfig;
+ private RequestConfig voidEnvelopeConfig;
+ private RequestConfig renameEnvelopeConfig;
+ private RequestConfig setEnvelopeCommentConfig;
+ private RequestConfig setEnvelopeNotificationConfig;
+ private RequestConfig setEnvelopeExpirationDateConfig;
+ private RequestConfig setEnvelopeLegalityLevelConfig;
+ private RequestConfig getEnvelopeAnnotationsConfig;
+ private RequestConfig getEnvelopeDocumentAnnotationsConfig;
+ private RequestConfig addEnvelopeAnnotationConfig;
+ private RequestConfig deleteEnvelopeAnnotationConfig;
+ private RequestConfig createTemplateConfig;
+ private RequestConfig listTemplatesConfig;
+ private RequestConfig getTemplateConfig;
+ private RequestConfig deleteTemplateConfig;
+ private RequestConfig duplicateTemplateConfig;
+ private RequestConfig addTemplateDocumentConfig;
+ private RequestConfig getTemplateDocumentConfig;
+ private RequestConfig getTemplateDocumentsConfig;
+ private RequestConfig addTemplateSigningStepsConfig;
+ private RequestConfig renameTemplateConfig;
+ private RequestConfig setTemplateCommentConfig;
+ private RequestConfig setTemplateNotificationConfig;
+ private RequestConfig getTemplateAnnotationsConfig;
+ private RequestConfig getDocumentTemplateAnnotationsConfig;
+ private RequestConfig addTemplateAnnotationConfig;
+ private RequestConfig deleteTemplateAnnotationConfig;
+ private RequestConfig setTemplateAttachmentsSettingsConfig;
+ private RequestConfig setTemplateAttachmentsPlaceholdersConfig;
+ private RequestConfig createWebhookConfig;
+ private RequestConfig listWebhooksConfig;
+ private RequestConfig deleteWebhookConfig;
+
+ /**
+ * Constructs a new instance of SignplusService.
+ *
+ * @param httpClient The HTTP client to use for requests
+ * @param config The SDK configuration
+ */
public SignplusService(@NonNull OkHttpClient httpClient, SignplusConfig config) {
super(httpClient, config);
}
+ /**
+ * Sets method-level configuration for {@code createEnvelope}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setCreateEnvelopeConfig(RequestConfig config) {
+ this.createEnvelopeConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code createEnvelopeFromTemplate}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setCreateEnvelopeFromTemplateConfig(RequestConfig config) {
+ this.createEnvelopeFromTemplateConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code listEnvelopes}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setListEnvelopesConfig(RequestConfig config) {
+ this.listEnvelopesConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getEnvelope}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetEnvelopeConfig(RequestConfig config) {
+ this.getEnvelopeConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code deleteEnvelope}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDeleteEnvelopeConfig(RequestConfig config) {
+ this.deleteEnvelopeConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code downloadEnvelopeSignedDocuments}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDownloadEnvelopeSignedDocumentsConfig(RequestConfig config) {
+ this.downloadEnvelopeSignedDocumentsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code downloadEnvelopeCertificate}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDownloadEnvelopeCertificateConfig(RequestConfig config) {
+ this.downloadEnvelopeCertificateConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getEnvelopeDocument}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetEnvelopeDocumentConfig(RequestConfig config) {
+ this.getEnvelopeDocumentConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getEnvelopeDocuments}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetEnvelopeDocumentsConfig(RequestConfig config) {
+ this.getEnvelopeDocumentsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code addEnvelopeDocument}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setAddEnvelopeDocumentConfig(RequestConfig config) {
+ this.addEnvelopeDocumentConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setEnvelopeDynamicFields}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetEnvelopeDynamicFieldsConfig(RequestConfig config) {
+ this.setEnvelopeDynamicFieldsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code addEnvelopeSigningSteps}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setAddEnvelopeSigningStepsConfig(RequestConfig config) {
+ this.addEnvelopeSigningStepsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setEnvelopeAttachmentsSettings}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetEnvelopeAttachmentsSettingsConfig(RequestConfig config) {
+ this.setEnvelopeAttachmentsSettingsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setEnvelopeAttachmentsPlaceholders}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetEnvelopeAttachmentsPlaceholdersConfig(RequestConfig config) {
+ this.setEnvelopeAttachmentsPlaceholdersConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getAttachmentFile}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetAttachmentFileConfig(RequestConfig config) {
+ this.getAttachmentFileConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code sendEnvelope}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSendEnvelopeConfig(RequestConfig config) {
+ this.sendEnvelopeConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code duplicateEnvelope}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDuplicateEnvelopeConfig(RequestConfig config) {
+ this.duplicateEnvelopeConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code voidEnvelope}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setVoidEnvelopeConfig(RequestConfig config) {
+ this.voidEnvelopeConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code renameEnvelope}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setRenameEnvelopeConfig(RequestConfig config) {
+ this.renameEnvelopeConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setEnvelopeComment}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetEnvelopeCommentConfig(RequestConfig config) {
+ this.setEnvelopeCommentConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setEnvelopeNotification}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetEnvelopeNotificationConfig(RequestConfig config) {
+ this.setEnvelopeNotificationConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setEnvelopeExpirationDate}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetEnvelopeExpirationDateConfig(RequestConfig config) {
+ this.setEnvelopeExpirationDateConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setEnvelopeLegalityLevel}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetEnvelopeLegalityLevelConfig(RequestConfig config) {
+ this.setEnvelopeLegalityLevelConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getEnvelopeAnnotations}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetEnvelopeAnnotationsConfig(RequestConfig config) {
+ this.getEnvelopeAnnotationsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getEnvelopeDocumentAnnotations}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetEnvelopeDocumentAnnotationsConfig(RequestConfig config) {
+ this.getEnvelopeDocumentAnnotationsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code addEnvelopeAnnotation}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setAddEnvelopeAnnotationConfig(RequestConfig config) {
+ this.addEnvelopeAnnotationConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code deleteEnvelopeAnnotation}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDeleteEnvelopeAnnotationConfig(RequestConfig config) {
+ this.deleteEnvelopeAnnotationConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code createTemplate}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setCreateTemplateConfig(RequestConfig config) {
+ this.createTemplateConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code listTemplates}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setListTemplatesConfig(RequestConfig config) {
+ this.listTemplatesConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getTemplate}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetTemplateConfig(RequestConfig config) {
+ this.getTemplateConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code deleteTemplate}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDeleteTemplateConfig(RequestConfig config) {
+ this.deleteTemplateConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code duplicateTemplate}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDuplicateTemplateConfig(RequestConfig config) {
+ this.duplicateTemplateConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code addTemplateDocument}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setAddTemplateDocumentConfig(RequestConfig config) {
+ this.addTemplateDocumentConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getTemplateDocument}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetTemplateDocumentConfig(RequestConfig config) {
+ this.getTemplateDocumentConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getTemplateDocuments}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetTemplateDocumentsConfig(RequestConfig config) {
+ this.getTemplateDocumentsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code addTemplateSigningSteps}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setAddTemplateSigningStepsConfig(RequestConfig config) {
+ this.addTemplateSigningStepsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code renameTemplate}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setRenameTemplateConfig(RequestConfig config) {
+ this.renameTemplateConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setTemplateComment}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetTemplateCommentConfig(RequestConfig config) {
+ this.setTemplateCommentConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setTemplateNotification}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetTemplateNotificationConfig(RequestConfig config) {
+ this.setTemplateNotificationConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getTemplateAnnotations}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetTemplateAnnotationsConfig(RequestConfig config) {
+ this.getTemplateAnnotationsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code getDocumentTemplateAnnotations}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setGetDocumentTemplateAnnotationsConfig(RequestConfig config) {
+ this.getDocumentTemplateAnnotationsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code addTemplateAnnotation}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setAddTemplateAnnotationConfig(RequestConfig config) {
+ this.addTemplateAnnotationConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code deleteTemplateAnnotation}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDeleteTemplateAnnotationConfig(RequestConfig config) {
+ this.deleteTemplateAnnotationConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setTemplateAttachmentsSettings}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetTemplateAttachmentsSettingsConfig(RequestConfig config) {
+ this.setTemplateAttachmentsSettingsConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code setTemplateAttachmentsPlaceholders}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setSetTemplateAttachmentsPlaceholdersConfig(RequestConfig config) {
+ this.setTemplateAttachmentsPlaceholdersConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code createWebhook}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setCreateWebhookConfig(RequestConfig config) {
+ this.createWebhookConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code listWebhooks}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setListWebhooksConfig(RequestConfig config) {
+ this.listWebhooksConfig = config;
+ return this;
+ }
+
+ /**
+ * Sets method-level configuration for {@code deleteWebhook}.
+ * Method-level overrides take precedence over service-level configuration but are
+ * overridden by request-level configurations.
+ *
+ * @param config The configuration overrides to apply at the method level
+ * @return This service instance for method chaining
+ */
+ public SignplusService setDeleteWebhookConfig(RequestConfig config) {
+ this.deleteWebhookConfig = config;
+ return this;
+ }
+
/**
* Create new envelope
*
@@ -77,9 +757,24 @@ public SignplusService(@NonNull OkHttpClient httpClient, SignplusConfig config)
*/
public Envelope createEnvelope(@NonNull CreateEnvelopeRequest createEnvelopeRequest)
throws ApiError, ValidationException {
- Request request = this.buildCreateEnvelopeRequest(createEnvelopeRequest);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ return this.createEnvelope(createEnvelopeRequest, null);
+ }
+
+ /**
+ * Create new envelope
+ *
+ * @param createEnvelopeRequest {@link CreateEnvelopeRequest} Request Body
+ * @return response of {@code Envelope}
+ */
+ public Envelope createEnvelope(
+ @NonNull CreateEnvelopeRequest createEnvelopeRequest,
+ RequestConfig requestConfig
+ ) throws ApiError, ValidationException {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.createEnvelopeConfig, requestConfig);
+ Request request = this.buildCreateEnvelopeRequest(createEnvelopeRequest, resolvedConfig);
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -88,25 +783,48 @@ public Envelope createEnvelope(@NonNull CreateEnvelopeRequest createEnvelopeRequ
* @param createEnvelopeRequest {@link CreateEnvelopeRequest} Request Body
* @return response of {@code CompletableFuture}
*/
- public CompletableFuture createEnvelopeAsync(@NonNull CreateEnvelopeRequest createEnvelopeRequest)
- throws ApiError, ValidationException {
- Request request = this.buildCreateEnvelopeRequest(createEnvelopeRequest);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.convert(response, new TypeReference() {})
- );
+ public CompletableFuture createEnvelopeAsync(
+ @NonNull CreateEnvelopeRequest createEnvelopeRequest
+ ) throws ApiError, ValidationException {
+ return this.createEnvelopeAsync(createEnvelopeRequest, null);
}
- private Request buildCreateEnvelopeRequest(@NonNull CreateEnvelopeRequest createEnvelopeRequest)
- throws ValidationException {
+ /**
+ * Create new envelope
+ *
+ * @param createEnvelopeRequest {@link CreateEnvelopeRequest} Request Body
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture createEnvelopeAsync(
+ @NonNull CreateEnvelopeRequest createEnvelopeRequest,
+ RequestConfig requestConfig
+ ) throws ApiError, ValidationException {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.createEnvelopeConfig, requestConfig);
+ Request request = this.buildCreateEnvelopeRequest(createEnvelopeRequest, resolvedConfig);
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
+ }
+
+ private Request buildCreateEnvelopeRequest(
+ @NonNull CreateEnvelopeRequest createEnvelopeRequest,
+ RequestConfig resolvedConfig
+ ) throws ValidationException {
new ViolationAggregator()
- .add(new CreateEnvelopeRequestValidator("createEnvelopeRequest").required().validate(createEnvelopeRequest))
+ .add(
+ new CreateEnvelopeRequestValidator("createEnvelopeRequest")
+ .required()
+ .validate(createEnvelopeRequest)
+ )
.validateAll();
return new RequestBuilder(
HttpMethod.POST,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setJsonContent(createEnvelopeRequest)
.build();
}
@@ -122,9 +840,32 @@ public Envelope createEnvelopeFromTemplate(
@NonNull String templateId,
@NonNull CreateEnvelopeFromTemplateRequest createEnvelopeFromTemplateRequest
) throws ApiError, ValidationException {
- Request request = this.buildCreateEnvelopeFromTemplateRequest(templateId, createEnvelopeFromTemplateRequest);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ return this.createEnvelopeFromTemplate(templateId, createEnvelopeFromTemplateRequest, null);
+ }
+
+ /**
+ * Create new envelope from template
+ *
+ * @param templateId String
+ * @param createEnvelopeFromTemplateRequest {@link CreateEnvelopeFromTemplateRequest} Request Body
+ * @return response of {@code Envelope}
+ */
+ public Envelope createEnvelopeFromTemplate(
+ @NonNull String templateId,
+ @NonNull CreateEnvelopeFromTemplateRequest createEnvelopeFromTemplateRequest,
+ RequestConfig requestConfig
+ ) throws ApiError, ValidationException {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.createEnvelopeFromTemplateConfig, requestConfig);
+ Request request =
+ this.buildCreateEnvelopeFromTemplateRequest(
+ templateId,
+ createEnvelopeFromTemplateRequest,
+ resolvedConfig
+ );
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -138,15 +879,44 @@ public CompletableFuture createEnvelopeFromTemplateAsync(
@NonNull String templateId,
@NonNull CreateEnvelopeFromTemplateRequest createEnvelopeFromTemplateRequest
) throws ApiError, ValidationException {
- Request request = this.buildCreateEnvelopeFromTemplateRequest(templateId, createEnvelopeFromTemplateRequest);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.convert(response, new TypeReference() {})
- );
+ return this.createEnvelopeFromTemplateAsync(
+ templateId,
+ createEnvelopeFromTemplateRequest,
+ null
+ );
+ }
+
+ /**
+ * Create new envelope from template
+ *
+ * @param templateId String
+ * @param createEnvelopeFromTemplateRequest {@link CreateEnvelopeFromTemplateRequest} Request Body
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture createEnvelopeFromTemplateAsync(
+ @NonNull String templateId,
+ @NonNull CreateEnvelopeFromTemplateRequest createEnvelopeFromTemplateRequest,
+ RequestConfig requestConfig
+ ) throws ApiError, ValidationException {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.createEnvelopeFromTemplateConfig, requestConfig);
+ Request request =
+ this.buildCreateEnvelopeFromTemplateRequest(
+ templateId,
+ createEnvelopeFromTemplateRequest,
+ resolvedConfig
+ );
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
}
private Request buildCreateEnvelopeFromTemplateRequest(
@NonNull String templateId,
- @NonNull CreateEnvelopeFromTemplateRequest createEnvelopeFromTemplateRequest
+ @NonNull CreateEnvelopeFromTemplateRequest createEnvelopeFromTemplateRequest,
+ RequestConfig resolvedConfig
) throws ValidationException {
new ViolationAggregator()
.add(
@@ -157,10 +927,10 @@ private Request buildCreateEnvelopeFromTemplateRequest(
.validateAll();
return new RequestBuilder(
HttpMethod.POST,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/from_template/{template_id}"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("template_id", templateId)
.setJsonContent(createEnvelopeFromTemplateRequest)
.build();
@@ -181,10 +951,26 @@ public ListEnvelopesResponse listEnvelopes() throws ApiError {
* @param listEnvelopesRequest {@link ListEnvelopesRequest} Request Body
* @return response of {@code ListEnvelopesResponse}
*/
- public ListEnvelopesResponse listEnvelopes(@NonNull ListEnvelopesRequest listEnvelopesRequest) throws ApiError {
- Request request = this.buildListEnvelopesRequest(listEnvelopesRequest);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ public ListEnvelopesResponse listEnvelopes(@NonNull ListEnvelopesRequest listEnvelopesRequest)
+ throws ApiError {
+ return this.listEnvelopes(listEnvelopesRequest, null);
+ }
+
+ /**
+ * List envelopes
+ *
+ * @param listEnvelopesRequest {@link ListEnvelopesRequest} Request Body
+ * @return response of {@code ListEnvelopesResponse}
+ */
+ public ListEnvelopesResponse listEnvelopes(
+ @NonNull ListEnvelopesRequest listEnvelopesRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.listEnvelopesConfig, requestConfig);
+ Request request = this.buildListEnvelopesRequest(listEnvelopesRequest, resolvedConfig);
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -205,20 +991,38 @@ public CompletableFuture listEnvelopesAsync() throws ApiE
public CompletableFuture listEnvelopesAsync(
@NonNull ListEnvelopesRequest listEnvelopesRequest
) throws ApiError {
- Request request = this.buildListEnvelopesRequest(listEnvelopesRequest);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response ->
- ModelConverter.convert(response, new TypeReference() {})
- );
+ return this.listEnvelopesAsync(listEnvelopesRequest, null);
}
- private Request buildListEnvelopesRequest(@NonNull ListEnvelopesRequest listEnvelopesRequest) {
+ /**
+ * List envelopes
+ *
+ * @param listEnvelopesRequest {@link ListEnvelopesRequest} Request Body
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture listEnvelopesAsync(
+ @NonNull ListEnvelopesRequest listEnvelopesRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.listEnvelopesConfig, requestConfig);
+ Request request = this.buildListEnvelopesRequest(listEnvelopesRequest, resolvedConfig);
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
+ }
+
+ private Request buildListEnvelopesRequest(
+ @NonNull ListEnvelopesRequest listEnvelopesRequest,
+ RequestConfig resolvedConfig
+ ) {
return new RequestBuilder(
HttpMethod.POST,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelopes"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setJsonContent(listEnvelopesRequest)
.build();
}
@@ -230,9 +1034,22 @@ private Request buildListEnvelopesRequest(@NonNull ListEnvelopesRequest listEnve
* @return response of {@code Envelope}
*/
public Envelope getEnvelope(@NonNull String envelopeId) throws ApiError {
- Request request = this.buildGetEnvelopeRequest(envelopeId);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ return this.getEnvelope(envelopeId, null);
+ }
+
+ /**
+ * Get envelope
+ *
+ * @param envelopeId String
+ * @return response of {@code Envelope}
+ */
+ public Envelope getEnvelope(@NonNull String envelopeId, RequestConfig requestConfig)
+ throws ApiError {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.getEnvelopeConfig, requestConfig);
+ Request request = this.buildGetEnvelopeRequest(envelopeId, resolvedConfig);
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -242,19 +1059,38 @@ public Envelope getEnvelope(@NonNull String envelopeId) throws ApiError {
* @return response of {@code CompletableFuture}
*/
public CompletableFuture getEnvelopeAsync(@NonNull String envelopeId) throws ApiError {
- Request request = this.buildGetEnvelopeRequest(envelopeId);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.convert(response, new TypeReference() {})
- );
+ return this.getEnvelopeAsync(envelopeId, null);
+ }
+
+ /**
+ * Get envelope
+ *
+ * @param envelopeId String
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture getEnvelopeAsync(
+ @NonNull String envelopeId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.getEnvelopeConfig, requestConfig);
+ Request request = this.buildGetEnvelopeRequest(envelopeId, resolvedConfig);
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
}
- private Request buildGetEnvelopeRequest(@NonNull String envelopeId) {
+ private Request buildGetEnvelopeRequest(
+ @NonNull String envelopeId,
+ RequestConfig resolvedConfig
+ ) {
return new RequestBuilder(
HttpMethod.GET,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.build();
}
@@ -266,8 +1102,20 @@ private Request buildGetEnvelopeRequest(@NonNull String envelopeId) {
* @return response of {@code void}
*/
public void deleteEnvelope(@NonNull String envelopeId) throws ApiError {
- Request request = this.buildDeleteEnvelopeRequest(envelopeId);
- this.execute(request);
+ this.deleteEnvelope(envelopeId, null);
+ }
+
+ /**
+ * Delete envelope
+ *
+ * @param envelopeId String
+ * @return response of {@code void}
+ */
+ public void deleteEnvelope(@NonNull String envelopeId, RequestConfig requestConfig)
+ throws ApiError {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.deleteEnvelopeConfig, requestConfig);
+ Request request = this.buildDeleteEnvelopeRequest(envelopeId, resolvedConfig);
+ this.execute(request, resolvedConfig);
}
/**
@@ -277,17 +1125,34 @@ public void deleteEnvelope(@NonNull String envelopeId) throws ApiError {
* @return response of {@code CompletableFuture}
*/
public CompletableFuture deleteEnvelopeAsync(@NonNull String envelopeId) throws ApiError {
- Request request = this.buildDeleteEnvelopeRequest(envelopeId);
- return this.executeAsync(request).thenApplyAsync(response -> null);
+ return this.deleteEnvelopeAsync(envelopeId, null);
+ }
+
+ /**
+ * Delete envelope
+ *
+ * @param envelopeId String
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture deleteEnvelopeAsync(
+ @NonNull String envelopeId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.deleteEnvelopeConfig, requestConfig);
+ Request request = this.buildDeleteEnvelopeRequest(envelopeId, resolvedConfig);
+ return this.executeAsync(request, resolvedConfig).thenApplyAsync(response -> null);
}
- private Request buildDeleteEnvelopeRequest(@NonNull String envelopeId) {
+ private Request buildDeleteEnvelopeRequest(
+ @NonNull String envelopeId,
+ RequestConfig resolvedConfig
+ ) {
return new RequestBuilder(
HttpMethod.DELETE,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.build();
}
@@ -303,9 +1168,32 @@ public byte[] downloadEnvelopeSignedDocuments(
@NonNull String envelopeId,
@NonNull DownloadEnvelopeSignedDocumentsParameters requestParameters
) throws ApiError {
- Request request = this.buildDownloadEnvelopeSignedDocumentsRequest(envelopeId, requestParameters);
- Response response = this.execute(request);
- return ModelConverter.readBytes(response);
+ return this.downloadEnvelopeSignedDocuments(envelopeId, requestParameters, null);
+ }
+
+ /**
+ * Download signed documents for an envelope
+ *
+ * @param envelopeId String ID of the envelope
+ * @param requestParameters {@link DownloadEnvelopeSignedDocumentsParameters} Request Parameters Object
+ * @return response of {@code byte[]}
+ */
+ public byte[] downloadEnvelopeSignedDocuments(
+ @NonNull String envelopeId,
+ @NonNull DownloadEnvelopeSignedDocumentsParameters requestParameters,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.downloadEnvelopeSignedDocumentsConfig, requestConfig);
+ Request request =
+ this.buildDownloadEnvelopeSignedDocumentsRequest(
+ envelopeId,
+ requestParameters,
+ resolvedConfig
+ );
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return bodyBytes;
}
/**
@@ -319,23 +1207,52 @@ public CompletableFuture downloadEnvelopeSignedDocumentsAsync(
@NonNull String envelopeId,
@NonNull DownloadEnvelopeSignedDocumentsParameters requestParameters
) throws ApiError {
- Request request = this.buildDownloadEnvelopeSignedDocumentsRequest(envelopeId, requestParameters);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.readBytes(response));
+ return this.downloadEnvelopeSignedDocumentsAsync(envelopeId, requestParameters, null);
+ }
+
+ /**
+ * Download signed documents for an envelope
+ *
+ * @param envelopeId String ID of the envelope
+ * @param requestParameters {@link DownloadEnvelopeSignedDocumentsParameters} Request Parameters Object
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture downloadEnvelopeSignedDocumentsAsync(
+ @NonNull String envelopeId,
+ @NonNull DownloadEnvelopeSignedDocumentsParameters requestParameters,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.downloadEnvelopeSignedDocumentsConfig, requestConfig);
+ Request request =
+ this.buildDownloadEnvelopeSignedDocumentsRequest(
+ envelopeId,
+ requestParameters,
+ resolvedConfig
+ );
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return bodyBytes;
+ });
}
private Request buildDownloadEnvelopeSignedDocumentsRequest(
@NonNull String envelopeId,
- @NonNull DownloadEnvelopeSignedDocumentsParameters requestParameters
+ @NonNull DownloadEnvelopeSignedDocumentsParameters requestParameters,
+ RequestConfig resolvedConfig
) {
return new RequestBuilder(
HttpMethod.GET,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/signed_documents"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
- .setOptionalQueryParameter("certificate_of_completion", requestParameters.getCertificateOfCompletion())
+ .setOptionalQueryParameter(
+ "certificate_of_completion",
+ requestParameters.getCertificateOfCompletion()
+ )
.build();
}
@@ -346,9 +1263,36 @@ private Request buildDownloadEnvelopeSignedDocumentsRequest(
* @return response of {@code byte[]}
*/
public byte[] downloadEnvelopeCertificate(@NonNull String envelopeId) throws ApiError {
- Request request = this.buildDownloadEnvelopeCertificateRequest(envelopeId);
- Response response = this.execute(request);
- return ModelConverter.readBytes(response);
+ return this.downloadEnvelopeCertificate(envelopeId, null);
+ }
+
+ /**
+ * Download certificate of completion for an envelope
+ *
+ * @param envelopeId String ID of the envelope
+ * @return response of {@code byte[]}
+ */
+ public byte[] downloadEnvelopeCertificate(
+ @NonNull String envelopeId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.downloadEnvelopeCertificateConfig, requestConfig);
+ Request request = this.buildDownloadEnvelopeCertificateRequest(envelopeId, resolvedConfig);
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return bodyBytes;
+ }
+
+ /**
+ * Download certificate of completion for an envelope
+ *
+ * @param envelopeId String ID of the envelope
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture downloadEnvelopeCertificateAsync(@NonNull String envelopeId)
+ throws ApiError {
+ return this.downloadEnvelopeCertificateAsync(envelopeId, null);
}
/**
@@ -357,19 +1301,30 @@ public byte[] downloadEnvelopeCertificate(@NonNull String envelopeId) throws Api
* @param envelopeId String ID of the envelope
* @return response of {@code CompletableFuture}
*/
- public CompletableFuture downloadEnvelopeCertificateAsync(@NonNull String envelopeId) throws ApiError {
- Request request = this.buildDownloadEnvelopeCertificateRequest(envelopeId);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.readBytes(response));
+ public CompletableFuture downloadEnvelopeCertificateAsync(
+ @NonNull String envelopeId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.downloadEnvelopeCertificateConfig, requestConfig);
+ Request request = this.buildDownloadEnvelopeCertificateRequest(envelopeId, resolvedConfig);
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return bodyBytes;
+ });
}
- private Request buildDownloadEnvelopeCertificateRequest(@NonNull String envelopeId) {
+ private Request buildDownloadEnvelopeCertificateRequest(
+ @NonNull String envelopeId,
+ RequestConfig resolvedConfig
+ ) {
return new RequestBuilder(
HttpMethod.GET,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/certificate"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.build();
}
@@ -381,10 +1336,29 @@ private Request buildDownloadEnvelopeCertificateRequest(@NonNull String envelope
* @param documentId String
* @return response of {@code Document}
*/
- public Document getEnvelopeDocument(@NonNull String envelopeId, @NonNull String documentId) throws ApiError {
- Request request = this.buildGetEnvelopeDocumentRequest(envelopeId, documentId);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ public Document getEnvelopeDocument(@NonNull String envelopeId, @NonNull String documentId)
+ throws ApiError {
+ return this.getEnvelopeDocument(envelopeId, documentId, null);
+ }
+
+ /**
+ * Get envelope document
+ *
+ * @param envelopeId String
+ * @param documentId String
+ * @return response of {@code Document}
+ */
+ public Document getEnvelopeDocument(
+ @NonNull String envelopeId,
+ @NonNull String documentId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.getEnvelopeDocumentConfig, requestConfig);
+ Request request = this.buildGetEnvelopeDocumentRequest(envelopeId, documentId, resolvedConfig);
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -394,21 +1368,46 @@ public Document getEnvelopeDocument(@NonNull String envelopeId, @NonNull String
* @param documentId String
* @return response of {@code CompletableFuture}
*/
- public CompletableFuture getEnvelopeDocumentAsync(@NonNull String envelopeId, @NonNull String documentId)
- throws ApiError {
- Request request = this.buildGetEnvelopeDocumentRequest(envelopeId, documentId);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.convert(response, new TypeReference() {})
- );
+ public CompletableFuture getEnvelopeDocumentAsync(
+ @NonNull String envelopeId,
+ @NonNull String documentId
+ ) throws ApiError {
+ return this.getEnvelopeDocumentAsync(envelopeId, documentId, null);
+ }
+
+ /**
+ * Get envelope document
+ *
+ * @param envelopeId String
+ * @param documentId String
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture getEnvelopeDocumentAsync(
+ @NonNull String envelopeId,
+ @NonNull String documentId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.getEnvelopeDocumentConfig, requestConfig);
+ Request request = this.buildGetEnvelopeDocumentRequest(envelopeId, documentId, resolvedConfig);
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
}
- private Request buildGetEnvelopeDocumentRequest(@NonNull String envelopeId, @NonNull String documentId) {
+ private Request buildGetEnvelopeDocumentRequest(
+ @NonNull String envelopeId,
+ @NonNull String documentId,
+ RequestConfig resolvedConfig
+ ) {
return new RequestBuilder(
HttpMethod.GET,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/document/{document_id}"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.setPathParameter("document_id", documentId)
.build();
@@ -420,10 +1419,27 @@ private Request buildGetEnvelopeDocumentRequest(@NonNull String envelopeId, @Non
* @param envelopeId String
* @return response of {@code ListEnvelopeDocumentsResponse}
*/
- public ListEnvelopeDocumentsResponse getEnvelopeDocuments(@NonNull String envelopeId) throws ApiError {
- Request request = this.buildGetEnvelopeDocumentsRequest(envelopeId);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ public ListEnvelopeDocumentsResponse getEnvelopeDocuments(@NonNull String envelopeId)
+ throws ApiError {
+ return this.getEnvelopeDocuments(envelopeId, null);
+ }
+
+ /**
+ * Get envelope documents
+ *
+ * @param envelopeId String
+ * @return response of {@code ListEnvelopeDocumentsResponse}
+ */
+ public ListEnvelopeDocumentsResponse getEnvelopeDocuments(
+ @NonNull String envelopeId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.getEnvelopeDocumentsConfig, requestConfig);
+ Request request = this.buildGetEnvelopeDocumentsRequest(envelopeId, resolvedConfig);
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -432,22 +1448,45 @@ public ListEnvelopeDocumentsResponse getEnvelopeDocuments(@NonNull String envelo
* @param envelopeId String
* @return response of {@code CompletableFuture}
*/
- public CompletableFuture getEnvelopeDocumentsAsync(@NonNull String envelopeId)
- throws ApiError {
- Request request = this.buildGetEnvelopeDocumentsRequest(envelopeId);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response ->
- ModelConverter.convert(response, new TypeReference() {})
- );
+ public CompletableFuture getEnvelopeDocumentsAsync(
+ @NonNull String envelopeId
+ ) throws ApiError {
+ return this.getEnvelopeDocumentsAsync(envelopeId, null);
+ }
+
+ /**
+ * Get envelope documents
+ *
+ * @param envelopeId String
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture getEnvelopeDocumentsAsync(
+ @NonNull String envelopeId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.getEnvelopeDocumentsConfig, requestConfig);
+ Request request = this.buildGetEnvelopeDocumentsRequest(envelopeId, resolvedConfig);
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(
+ bodyBytes,
+ new TypeReference() {}
+ );
+ });
}
- private Request buildGetEnvelopeDocumentsRequest(@NonNull String envelopeId) {
+ private Request buildGetEnvelopeDocumentsRequest(
+ @NonNull String envelopeId,
+ RequestConfig resolvedConfig
+ ) {
return new RequestBuilder(
HttpMethod.GET,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/documents"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.build();
}
@@ -465,9 +1504,35 @@ public Document addEnvelopeDocument(
@NonNull AddEnvelopeDocumentRequest addEnvelopeDocumentRequest,
@NonNull String _filename
) throws ApiError {
- Request request = this.buildAddEnvelopeDocumentRequest(envelopeId, addEnvelopeDocumentRequest, _filename);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ return this.addEnvelopeDocument(envelopeId, addEnvelopeDocumentRequest, _filename, null);
+ }
+
+ /**
+ * Add envelope document
+ *
+ * @param envelopeId String
+ * @param addEnvelopeDocumentRequest {@link AddEnvelopeDocumentRequest} Request Body
+ * @param _filename String Filename for the uploaded file
+ * @return response of {@code Document}
+ */
+ public Document addEnvelopeDocument(
+ @NonNull String envelopeId,
+ @NonNull AddEnvelopeDocumentRequest addEnvelopeDocumentRequest,
+ @NonNull String _filename,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.addEnvelopeDocumentConfig, requestConfig);
+ Request request =
+ this.buildAddEnvelopeDocumentRequest(
+ envelopeId,
+ addEnvelopeDocumentRequest,
+ _filename,
+ resolvedConfig
+ );
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -483,31 +1548,63 @@ public CompletableFuture addEnvelopeDocumentAsync(
@NonNull AddEnvelopeDocumentRequest addEnvelopeDocumentRequest,
@NonNull String _filename
) throws ApiError {
- Request request = this.buildAddEnvelopeDocumentRequest(envelopeId, addEnvelopeDocumentRequest, _filename);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.convert(response, new TypeReference() {})
- );
+ return this.addEnvelopeDocumentAsync(envelopeId, addEnvelopeDocumentRequest, _filename, null);
+ }
+
+ /**
+ * Add envelope document
+ *
+ * @param envelopeId String
+ * @param addEnvelopeDocumentRequest {@link AddEnvelopeDocumentRequest} Request Body
+ * @param _filename String Filename for the uploaded file
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture addEnvelopeDocumentAsync(
+ @NonNull String envelopeId,
+ @NonNull AddEnvelopeDocumentRequest addEnvelopeDocumentRequest,
+ @NonNull String _filename,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.addEnvelopeDocumentConfig, requestConfig);
+ Request request =
+ this.buildAddEnvelopeDocumentRequest(
+ envelopeId,
+ addEnvelopeDocumentRequest,
+ _filename,
+ resolvedConfig
+ );
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
}
private Request buildAddEnvelopeDocumentRequest(
@NonNull String envelopeId,
@NonNull AddEnvelopeDocumentRequest addEnvelopeDocumentRequest,
- @NonNull String _filename
+ @NonNull String _filename,
+ RequestConfig resolvedConfig
) {
- MultipartBody.Builder multipartBodyBuilder = new MultipartBody.Builder().setType(MultipartBody.FORM);
+ MultipartBody.Builder multipartBodyBuilder = new MultipartBody.Builder()
+ .setType(MultipartBody.FORM);
if (addEnvelopeDocumentRequest.getFile() != null) {
multipartBodyBuilder.addFormDataPart(
"file",
_filename,
- RequestBody.create(addEnvelopeDocumentRequest.getFile(), MediaType.parse("application/octet-stream"))
+ RequestBody.create(
+ addEnvelopeDocumentRequest.getFile(),
+ MediaType.parse("application/octet-stream")
+ )
);
}
return new RequestBuilder(
HttpMethod.POST,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/document"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.setBody(multipartBodyBuilder.build())
.build();
@@ -524,9 +1621,32 @@ public Envelope setEnvelopeDynamicFields(
@NonNull String envelopeId,
@NonNull SetEnvelopeDynamicFieldsRequest setEnvelopeDynamicFieldsRequest
) throws ApiError {
- Request request = this.buildSetEnvelopeDynamicFieldsRequest(envelopeId, setEnvelopeDynamicFieldsRequest);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ return this.setEnvelopeDynamicFields(envelopeId, setEnvelopeDynamicFieldsRequest, null);
+ }
+
+ /**
+ * Set envelope dynamic fields
+ *
+ * @param envelopeId String
+ * @param setEnvelopeDynamicFieldsRequest {@link SetEnvelopeDynamicFieldsRequest} Request Body
+ * @return response of {@code Envelope}
+ */
+ public Envelope setEnvelopeDynamicFields(
+ @NonNull String envelopeId,
+ @NonNull SetEnvelopeDynamicFieldsRequest setEnvelopeDynamicFieldsRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.setEnvelopeDynamicFieldsConfig, requestConfig);
+ Request request =
+ this.buildSetEnvelopeDynamicFieldsRequest(
+ envelopeId,
+ setEnvelopeDynamicFieldsRequest,
+ resolvedConfig
+ );
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -540,22 +1660,47 @@ public CompletableFuture setEnvelopeDynamicFieldsAsync(
@NonNull String envelopeId,
@NonNull SetEnvelopeDynamicFieldsRequest setEnvelopeDynamicFieldsRequest
) throws ApiError {
- Request request = this.buildSetEnvelopeDynamicFieldsRequest(envelopeId, setEnvelopeDynamicFieldsRequest);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.convert(response, new TypeReference() {})
- );
+ return this.setEnvelopeDynamicFieldsAsync(envelopeId, setEnvelopeDynamicFieldsRequest, null);
+ }
+
+ /**
+ * Set envelope dynamic fields
+ *
+ * @param envelopeId String
+ * @param setEnvelopeDynamicFieldsRequest {@link SetEnvelopeDynamicFieldsRequest} Request Body
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture setEnvelopeDynamicFieldsAsync(
+ @NonNull String envelopeId,
+ @NonNull SetEnvelopeDynamicFieldsRequest setEnvelopeDynamicFieldsRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.setEnvelopeDynamicFieldsConfig, requestConfig);
+ Request request =
+ this.buildSetEnvelopeDynamicFieldsRequest(
+ envelopeId,
+ setEnvelopeDynamicFieldsRequest,
+ resolvedConfig
+ );
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
}
private Request buildSetEnvelopeDynamicFieldsRequest(
@NonNull String envelopeId,
- @NonNull SetEnvelopeDynamicFieldsRequest setEnvelopeDynamicFieldsRequest
+ @NonNull SetEnvelopeDynamicFieldsRequest setEnvelopeDynamicFieldsRequest,
+ RequestConfig resolvedConfig
) {
return new RequestBuilder(
HttpMethod.PUT,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/dynamic_fields"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.setJsonContent(setEnvelopeDynamicFieldsRequest)
.build();
@@ -566,15 +1711,52 @@ private Request buildSetEnvelopeDynamicFieldsRequest(
*
* @param envelopeId String
* @param addEnvelopeSigningStepsRequest {@link AddEnvelopeSigningStepsRequest} Request Body
- * @return response of {@code Envelope}
+ * @return response of {@code Envelope}
+ */
+ public Envelope addEnvelopeSigningSteps(
+ @NonNull String envelopeId,
+ @NonNull AddEnvelopeSigningStepsRequest addEnvelopeSigningStepsRequest
+ ) throws ApiError {
+ return this.addEnvelopeSigningSteps(envelopeId, addEnvelopeSigningStepsRequest, null);
+ }
+
+ /**
+ * Add envelope signing steps
+ *
+ * @param envelopeId String
+ * @param addEnvelopeSigningStepsRequest {@link AddEnvelopeSigningStepsRequest} Request Body
+ * @return response of {@code Envelope}
+ */
+ public Envelope addEnvelopeSigningSteps(
+ @NonNull String envelopeId,
+ @NonNull AddEnvelopeSigningStepsRequest addEnvelopeSigningStepsRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.addEnvelopeSigningStepsConfig, requestConfig);
+ Request request =
+ this.buildAddEnvelopeSigningStepsRequest(
+ envelopeId,
+ addEnvelopeSigningStepsRequest,
+ resolvedConfig
+ );
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ }
+
+ /**
+ * Add envelope signing steps
+ *
+ * @param envelopeId String
+ * @param addEnvelopeSigningStepsRequest {@link AddEnvelopeSigningStepsRequest} Request Body
+ * @return response of {@code CompletableFuture}
*/
- public Envelope addEnvelopeSigningSteps(
+ public CompletableFuture addEnvelopeSigningStepsAsync(
@NonNull String envelopeId,
@NonNull AddEnvelopeSigningStepsRequest addEnvelopeSigningStepsRequest
) throws ApiError {
- Request request = this.buildAddEnvelopeSigningStepsRequest(envelopeId, addEnvelopeSigningStepsRequest);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ return this.addEnvelopeSigningStepsAsync(envelopeId, addEnvelopeSigningStepsRequest, null);
}
/**
@@ -586,24 +1768,35 @@ public Envelope addEnvelopeSigningSteps(
*/
public CompletableFuture addEnvelopeSigningStepsAsync(
@NonNull String envelopeId,
- @NonNull AddEnvelopeSigningStepsRequest addEnvelopeSigningStepsRequest
+ @NonNull AddEnvelopeSigningStepsRequest addEnvelopeSigningStepsRequest,
+ RequestConfig requestConfig
) throws ApiError {
- Request request = this.buildAddEnvelopeSigningStepsRequest(envelopeId, addEnvelopeSigningStepsRequest);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.convert(response, new TypeReference() {})
- );
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.addEnvelopeSigningStepsConfig, requestConfig);
+ Request request =
+ this.buildAddEnvelopeSigningStepsRequest(
+ envelopeId,
+ addEnvelopeSigningStepsRequest,
+ resolvedConfig
+ );
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
}
private Request buildAddEnvelopeSigningStepsRequest(
@NonNull String envelopeId,
- @NonNull AddEnvelopeSigningStepsRequest addEnvelopeSigningStepsRequest
+ @NonNull AddEnvelopeSigningStepsRequest addEnvelopeSigningStepsRequest,
+ RequestConfig resolvedConfig
) {
return new RequestBuilder(
HttpMethod.POST,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/signing_steps"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.setJsonContent(addEnvelopeSigningStepsRequest)
.build();
@@ -620,10 +1813,36 @@ public EnvelopeAttachments setEnvelopeAttachmentsSettings(
@NonNull String envelopeId,
@NonNull SetEnvelopeAttachmentsSettingsRequest setEnvelopeAttachmentsSettingsRequest
) throws ApiError {
+ return this.setEnvelopeAttachmentsSettings(
+ envelopeId,
+ setEnvelopeAttachmentsSettingsRequest,
+ null
+ );
+ }
+
+ /**
+ * Set envelope attachment settings
+ *
+ * @param envelopeId String
+ * @param setEnvelopeAttachmentsSettingsRequest {@link SetEnvelopeAttachmentsSettingsRequest} Request Body
+ * @return response of {@code EnvelopeAttachments}
+ */
+ public EnvelopeAttachments setEnvelopeAttachmentsSettings(
+ @NonNull String envelopeId,
+ @NonNull SetEnvelopeAttachmentsSettingsRequest setEnvelopeAttachmentsSettingsRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.setEnvelopeAttachmentsSettingsConfig, requestConfig);
Request request =
- this.buildSetEnvelopeAttachmentsSettingsRequest(envelopeId, setEnvelopeAttachmentsSettingsRequest);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ this.buildSetEnvelopeAttachmentsSettingsRequest(
+ envelopeId,
+ setEnvelopeAttachmentsSettingsRequest,
+ resolvedConfig
+ );
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -637,24 +1856,51 @@ public CompletableFuture setEnvelopeAttachmentsSettingsAsyn
@NonNull String envelopeId,
@NonNull SetEnvelopeAttachmentsSettingsRequest setEnvelopeAttachmentsSettingsRequest
) throws ApiError {
+ return this.setEnvelopeAttachmentsSettingsAsync(
+ envelopeId,
+ setEnvelopeAttachmentsSettingsRequest,
+ null
+ );
+ }
+
+ /**
+ * Set envelope attachment settings
+ *
+ * @param envelopeId String
+ * @param setEnvelopeAttachmentsSettingsRequest {@link SetEnvelopeAttachmentsSettingsRequest} Request Body
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture setEnvelopeAttachmentsSettingsAsync(
+ @NonNull String envelopeId,
+ @NonNull SetEnvelopeAttachmentsSettingsRequest setEnvelopeAttachmentsSettingsRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.setEnvelopeAttachmentsSettingsConfig, requestConfig);
Request request =
- this.buildSetEnvelopeAttachmentsSettingsRequest(envelopeId, setEnvelopeAttachmentsSettingsRequest);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response ->
- ModelConverter.convert(response, new TypeReference() {})
- );
+ this.buildSetEnvelopeAttachmentsSettingsRequest(
+ envelopeId,
+ setEnvelopeAttachmentsSettingsRequest,
+ resolvedConfig
+ );
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
}
private Request buildSetEnvelopeAttachmentsSettingsRequest(
@NonNull String envelopeId,
- @NonNull SetEnvelopeAttachmentsSettingsRequest setEnvelopeAttachmentsSettingsRequest
+ @NonNull SetEnvelopeAttachmentsSettingsRequest setEnvelopeAttachmentsSettingsRequest,
+ RequestConfig resolvedConfig
) {
return new RequestBuilder(
HttpMethod.PUT,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/attachments/settings"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.setJsonContent(setEnvelopeAttachmentsSettingsRequest)
.build();
@@ -671,10 +1917,36 @@ public EnvelopeAttachments setEnvelopeAttachmentsPlaceholders(
@NonNull String envelopeId,
@NonNull SetEnvelopeAttachmentsPlaceholdersRequest setEnvelopeAttachmentsPlaceholdersRequest
) throws ApiError {
+ return this.setEnvelopeAttachmentsPlaceholders(
+ envelopeId,
+ setEnvelopeAttachmentsPlaceholdersRequest,
+ null
+ );
+ }
+
+ /**
+ * Placeholders to be set, completely replacing the existing ones.
+ *
+ * @param envelopeId String
+ * @param setEnvelopeAttachmentsPlaceholdersRequest {@link SetEnvelopeAttachmentsPlaceholdersRequest} Request Body
+ * @return response of {@code EnvelopeAttachments}
+ */
+ public EnvelopeAttachments setEnvelopeAttachmentsPlaceholders(
+ @NonNull String envelopeId,
+ @NonNull SetEnvelopeAttachmentsPlaceholdersRequest setEnvelopeAttachmentsPlaceholdersRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.setEnvelopeAttachmentsPlaceholdersConfig, requestConfig);
Request request =
- this.buildSetEnvelopeAttachmentsPlaceholdersRequest(envelopeId, setEnvelopeAttachmentsPlaceholdersRequest);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ this.buildSetEnvelopeAttachmentsPlaceholdersRequest(
+ envelopeId,
+ setEnvelopeAttachmentsPlaceholdersRequest,
+ resolvedConfig
+ );
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -688,24 +1960,51 @@ public CompletableFuture setEnvelopeAttachmentsPlaceholders
@NonNull String envelopeId,
@NonNull SetEnvelopeAttachmentsPlaceholdersRequest setEnvelopeAttachmentsPlaceholdersRequest
) throws ApiError {
+ return this.setEnvelopeAttachmentsPlaceholdersAsync(
+ envelopeId,
+ setEnvelopeAttachmentsPlaceholdersRequest,
+ null
+ );
+ }
+
+ /**
+ * Placeholders to be set, completely replacing the existing ones.
+ *
+ * @param envelopeId String
+ * @param setEnvelopeAttachmentsPlaceholdersRequest {@link SetEnvelopeAttachmentsPlaceholdersRequest} Request Body
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture setEnvelopeAttachmentsPlaceholdersAsync(
+ @NonNull String envelopeId,
+ @NonNull SetEnvelopeAttachmentsPlaceholdersRequest setEnvelopeAttachmentsPlaceholdersRequest,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.setEnvelopeAttachmentsPlaceholdersConfig, requestConfig);
Request request =
- this.buildSetEnvelopeAttachmentsPlaceholdersRequest(envelopeId, setEnvelopeAttachmentsPlaceholdersRequest);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response ->
- ModelConverter.convert(response, new TypeReference() {})
- );
+ this.buildSetEnvelopeAttachmentsPlaceholdersRequest(
+ envelopeId,
+ setEnvelopeAttachmentsPlaceholdersRequest,
+ resolvedConfig
+ );
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
+ });
}
private Request buildSetEnvelopeAttachmentsPlaceholdersRequest(
@NonNull String envelopeId,
- @NonNull SetEnvelopeAttachmentsPlaceholdersRequest setEnvelopeAttachmentsPlaceholdersRequest
+ @NonNull SetEnvelopeAttachmentsPlaceholdersRequest setEnvelopeAttachmentsPlaceholdersRequest,
+ RequestConfig resolvedConfig
) {
return new RequestBuilder(
HttpMethod.PUT,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/attachments/placeholders"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.setJsonContent(setEnvelopeAttachmentsPlaceholdersRequest)
.build();
@@ -718,10 +2017,29 @@ private Request buildSetEnvelopeAttachmentsPlaceholdersRequest(
* @param fileId String
* @return response of {@code byte[]}
*/
- public byte[] getAttachmentFile(@NonNull String envelopeId, @NonNull String fileId) throws ApiError {
- Request request = this.buildGetAttachmentFileRequest(envelopeId, fileId);
- Response response = this.execute(request);
- return ModelConverter.readBytes(response);
+ public byte[] getAttachmentFile(@NonNull String envelopeId, @NonNull String fileId)
+ throws ApiError {
+ return this.getAttachmentFile(envelopeId, fileId, null);
+ }
+
+ /**
+ * Get envelope attachment file
+ *
+ * @param envelopeId String
+ * @param fileId String
+ * @return response of {@code byte[]}
+ */
+ public byte[] getAttachmentFile(
+ @NonNull String envelopeId,
+ @NonNull String fileId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.getAttachmentFileConfig, requestConfig);
+ Request request = this.buildGetAttachmentFileRequest(envelopeId, fileId, resolvedConfig);
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return bodyBytes;
}
/**
@@ -731,20 +2049,46 @@ public byte[] getAttachmentFile(@NonNull String envelopeId, @NonNull String file
* @param fileId String
* @return response of {@code CompletableFuture}
*/
- public CompletableFuture getAttachmentFileAsync(@NonNull String envelopeId, @NonNull String fileId)
- throws ApiError {
- Request request = this.buildGetAttachmentFileRequest(envelopeId, fileId);
- CompletableFuture futureResponse = this.executeAsync(request);
- return futureResponse.thenApplyAsync(response -> ModelConverter.readBytes(response));
+ public CompletableFuture getAttachmentFileAsync(
+ @NonNull String envelopeId,
+ @NonNull String fileId
+ ) throws ApiError {
+ return this.getAttachmentFileAsync(envelopeId, fileId, null);
+ }
+
+ /**
+ * Get envelope attachment file
+ *
+ * @param envelopeId String
+ * @param fileId String
+ * @return response of {@code CompletableFuture}
+ */
+ public CompletableFuture getAttachmentFileAsync(
+ @NonNull String envelopeId,
+ @NonNull String fileId,
+ RequestConfig requestConfig
+ ) throws ApiError {
+ RequestConfig resolvedConfig =
+ this.getResolvedConfig(this.getAttachmentFileConfig, requestConfig);
+ Request request = this.buildGetAttachmentFileRequest(envelopeId, fileId, resolvedConfig);
+ CompletableFuture futureResponse = this.executeAsync(request, resolvedConfig);
+ return futureResponse.thenApplyAsync(response -> {
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return bodyBytes;
+ });
}
- private Request buildGetAttachmentFileRequest(@NonNull String envelopeId, @NonNull String fileId) {
+ private Request buildGetAttachmentFileRequest(
+ @NonNull String envelopeId,
+ @NonNull String fileId,
+ RequestConfig resolvedConfig
+ ) {
return new RequestBuilder(
HttpMethod.GET,
- Optional.ofNullable(this.config.getBaseUrl()).orElse(Environment.DEFAULT.getUrl()),
+ resolveBaseUrl(resolvedConfig, Environment.DEFAULT),
"envelope/{envelope_id}/attachments/{file_id}"
)
- .setAccessTokenAuth(this.config.getAccessToken(), "Bearer")
+ .setAccessTokenAuth(resolveAccessToken(resolvedConfig), "Bearer")
.setPathParameter("envelope_id", envelopeId)
.setPathParameter("file_id", fileId)
.build();
@@ -757,9 +2101,22 @@ private Request buildGetAttachmentFileRequest(@NonNull String envelopeId, @NonNu
* @return response of {@code Envelope}
*/
public Envelope sendEnvelope(@NonNull String envelopeId) throws ApiError {
- Request request = this.buildSendEnvelopeRequest(envelopeId);
- Response response = this.execute(request);
- return ModelConverter.convert(response, new TypeReference() {});
+ return this.sendEnvelope(envelopeId, null);
+ }
+
+ /**
+ * Send envelope for signature
+ *
+ * @param envelopeId String
+ * @return response of {@code Envelope}
+ */
+ public Envelope sendEnvelope(@NonNull String envelopeId, RequestConfig requestConfig)
+ throws ApiError {
+ RequestConfig resolvedConfig = this.getResolvedConfig(this.sendEnvelopeConfig, requestConfig);
+ Request request = this.buildSendEnvelopeRequest(envelopeId, resolvedConfig);
+ Response response = this.execute(request, resolvedConfig);
+ byte[] bodyBytes = ModelConverter.readBytes(response);
+ return ModelConverter.convert(bodyBytes, new TypeReference() {});
}
/**
@@ -769,19 +2126,38 @@ public Envelope sendEnvelope(@NonNull String envelopeId) throws ApiError {
* @return response of {@code CompletableFuture