Proxy improvements (#195)

* Handle non-JSON payloads and other response types
  in the Proxy

  The `proxy` module now supports non-JSON payloads.
  Since the downstream services that the Proxy can call
  do not necessarily respond with JSON content, the new
  logic will inspect the `Content-Type` header in the
  response to determine whether the payload should be parsed
  as JSON or returned back to the caller as a byte stream
  (especially useful for downloading files).

  ```java
  ProxyResponse response = client.proxy().get(url, request, requestOptions);
  // The SDK returns a stream for binary responses
  if (response.isStream()) {
      try (InputStream stream = response.stream();
          FileOutputStream fos = new FileOutputStream(outputPath)) {
          byte[] buffer = new byte[8192];
          int bytesRead;
          while ((bytesRead = stream.read(buffer)) != -1) {
              fos.write(buffer, 0, bytesRead);
          }
      }
      System.out.println("File downloaded to: " + outputPath);
  }
  ```

* Improve ergonomics for query parameters

  When passing query parameters to the downstream service, users had to
  previously encode them manually inside a `url` string. Now, every method in
  the Proxy clients accepts an `HttpUrl` instance, which allows users to
  build URLs with query parameters in a more ergonomic way:

  ```java
  HttpUrl url = HttpUrl.parse(GDRIVE_API_BASE)
    .newBuilder()
    .addPathSegment(fileId)
    .addQueryParameter("fields", "name,mimeType,size")
    .build();

  ProxyGetRequest request = ProxyGetRequest.builder()
    .externalUserId(externalUserId)
    .accountId(accountId)
    .build();
  ```

---------

Co-authored-by: Jay Vercellone <jay@pipedream.com>

Author: fern-api[bot]

.fernignore

@@ -20,6 +20,16 @@ src/main/java/com/pipedream/api/PipedreamClient.java
 src/main/java/com/pipedream/api/PipedreamClientBuilder.java
 
 # Custom Proxy files
+src/main/java/com/pipedream/api/resources/proxy/AsyncProxyClient.java
+src/main/java/com/pipedream/api/resources/proxy/AsyncRawProxyClient.java
+src/main/java/com/pipedream/api/resources/proxy/ProxyClient.java
+src/main/java/com/pipedream/api/resources/proxy/RawProxyClient.java
+src/main/java/com/pipedream/api/resources/proxy/requests/ProxyDeleteRequest.java
+src/main/java/com/pipedream/api/resources/proxy/requests/ProxyGetRequest.java
+src/main/java/com/pipedream/api/resources/proxy/requests/ProxyPatchRequest.java
+src/main/java/com/pipedream/api/resources/proxy/requests/ProxyPostRequest.java
+src/main/java/com/pipedream/api/resources/proxy/requests/ProxyPutRequest.java
+src/main/java/com/pipedream/api/resources/proxy/types/ProxyResponse.java
 
 # Custom Workflow files
 src/main/java/com/pipedream/api/resources/workflows/AsyncWorkflowsClient.java

README.md

@@ -5,6 +5,21 @@
 
 The Pipedream Java library provides convenient access to the Pipedream APIs from Java.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Base Url](#base-url)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Custom Client](#custom-client)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Headers](#custom-headers)
+- [Contributing](#contributing)
+- [Reference](#reference)
+
 ## Installation
 
 ### Gradle
@@ -25,7 +40,7 @@ Add the dependency in your `pom.xml` file:
 <dependency>
   <groupId>com.pipedream</groupId>
   <artifactId>pipedream</artifactId>
-  <version>1.1.0</version>
+  <version>1.1.1</version>
 </dependency>
 ```
 

build.gradle

@@ -49,7 +49,7 @@ java {
 
 group = 'com.pipedream'
 
-version = '1.1.0'
+version = '1.1.1'
 
 jar {
     dependsOn(":generatePomFileForMavenPublication")
@@ -80,7 +80,7 @@ publishing {
         maven(MavenPublication) {
             groupId = 'com.pipedream'
             artifactId = 'pipedream'
-            version = '1.1.0'
+            version = '1.1.1'
             from components.java
             pom {
                 name = 'pipedream'

src/main/java/com/pipedream/api/core/ClientOptions.java

@@ -35,10 +35,10 @@ private ClientOptions(
         this.headers.putAll(headers);
         this.headers.putAll(new HashMap<String, String>() {
             {
-                put("User-Agent", "com.pipedream:pipedream/1.1.0");
+                put("User-Agent", "com.pipedream:pipedream/1.1.1");
                 put("X-Fern-Language", "JAVA");
                 put("X-Fern-SDK-Name", "com.pipedream.fern:api-sdk");
-                put("X-Fern-SDK-Version", "1.1.0");
+                put("X-Fern-SDK-Version", "1.1.1");
             }
         });
         this.headerSuppliers = headerSuppliers;

src/main/java/com/pipedream/api/resources/proxy/AsyncProxyClient.java

@@ -10,8 +10,10 @@
 import com.pipedream.api.resources.proxy.requests.ProxyPatchRequest;
 import com.pipedream.api.resources.proxy.requests.ProxyPostRequest;
 import com.pipedream.api.resources.proxy.requests.ProxyPutRequest;
+import com.pipedream.api.resources.proxy.types.ProxyResponse;
 import java.util.Base64;
 import java.util.concurrent.CompletableFuture;
+import okhttp3.HttpUrl;
 
 public class AsyncProxyClient {
     protected final ClientOptions clientOptions;
@@ -37,80 +39,154 @@ public AsyncRawProxyClient withRawResponse() {
     /**
      * Forward an authenticated GET request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> get(String url, ProxyGetRequest request) {
+    public CompletableFuture<ProxyResponse> get(String url, ProxyGetRequest request) {
         final String url64 = encodeUrl(url);
         return this.rawClient.get(url64, request).thenApply(response -> response.body());
     }
 
     /**
      * Forward an authenticated GET request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> get(String url, ProxyGetRequest request, RequestOptions requestOptions) {
+    public CompletableFuture<ProxyResponse> get(HttpUrl url, ProxyGetRequest request) {
+        return get(url.toString(), request);
+    }
+
+    /**
+     * Forward an authenticated GET request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> get(String url, ProxyGetRequest request, RequestOptions requestOptions) {
         final String url64 = encodeUrl(url);
         return this.rawClient.get(url64, request, requestOptions).thenApply(response -> response.body());
     }
 
+    /**
+     * Forward an authenticated GET request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> get(HttpUrl url, ProxyGetRequest request, RequestOptions requestOptions) {
+        return get(url.toString(), request, requestOptions);
+    }
+
     /**
      * Forward an authenticated POST request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> post(String url, ProxyPostRequest request) {
+    public CompletableFuture<ProxyResponse> post(String url, ProxyPostRequest request) {
         final String url64 = encodeUrl(url);
         return this.rawClient.post(url64, request).thenApply(response -> response.body());
     }
 
     /**
      * Forward an authenticated POST request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> post(String url, ProxyPostRequest request, RequestOptions requestOptions) {
+    public CompletableFuture<ProxyResponse> post(HttpUrl url, ProxyPostRequest request) {
+        return post(url.toString(), request);
+    }
+
+    /**
+     * Forward an authenticated POST request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> post(String url, ProxyPostRequest request, RequestOptions requestOptions) {
         final String url64 = encodeUrl(url);
         return this.rawClient.post(url64, request, requestOptions).thenApply(response -> response.body());
     }
 
+    /**
+     * Forward an authenticated POST request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> post(HttpUrl url, ProxyPostRequest request, RequestOptions requestOptions) {
+        return post(url.toString(), request, requestOptions);
+    }
+
     /**
      * Forward an authenticated PUT request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> put(String url, ProxyPutRequest request) {
+    public CompletableFuture<ProxyResponse> put(String url, ProxyPutRequest request) {
         final String url64 = encodeUrl(url);
         return this.rawClient.put(url64, request).thenApply(response -> response.body());
     }
 
     /**
      * Forward an authenticated PUT request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> put(String url, ProxyPutRequest request, RequestOptions requestOptions) {
+    public CompletableFuture<ProxyResponse> put(HttpUrl url, ProxyPutRequest request) {
+        return put(url.toString(), request);
+    }
+
+    /**
+     * Forward an authenticated PUT request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> put(String url, ProxyPutRequest request, RequestOptions requestOptions) {
         final String url64 = encodeUrl(url);
         return this.rawClient.put(url64, request, requestOptions).thenApply(response -> response.body());
     }
 
+    /**
+     * Forward an authenticated PUT request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> put(HttpUrl url, ProxyPutRequest request, RequestOptions requestOptions) {
+        return put(url.toString(), request, requestOptions);
+    }
+
     /**
      * Forward an authenticated DELETE request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> delete(String url, ProxyDeleteRequest request) {
+    public CompletableFuture<ProxyResponse> delete(String url, ProxyDeleteRequest request) {
         final String url64 = encodeUrl(url);
         return this.rawClient.delete(url64, request).thenApply(response -> response.body());
     }
 
     /**
      * Forward an authenticated DELETE request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> delete(String url, ProxyDeleteRequest request, RequestOptions requestOptions) {
+    public CompletableFuture<ProxyResponse> delete(HttpUrl url, ProxyDeleteRequest request) {
+        return delete(url.toString(), request);
+    }
+
+    /**
+     * Forward an authenticated DELETE request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> delete(
+            String url, ProxyDeleteRequest request, RequestOptions requestOptions) {
         final String url64 = encodeUrl(url);
         return this.rawClient.delete(url64, request, requestOptions).thenApply(response -> response.body());
     }
 
+    /**
+     * Forward an authenticated DELETE request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> delete(
+            HttpUrl url, ProxyDeleteRequest request, RequestOptions requestOptions) {
+        return delete(url.toString(), request, requestOptions);
+    }
+
     /**
      * Forward an authenticated PATCH request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> patch(String url, ProxyPatchRequest request) {
+    public CompletableFuture<ProxyResponse> patch(String url, ProxyPatchRequest request) {
         final String url64 = encodeUrl(url);
         return this.rawClient.patch(url64, request).thenApply(response -> response.body());
     }
 
     /**
      * Forward an authenticated PATCH request to an external API using an external user's account credentials
      */
-    public CompletableFuture<Object> patch(String url, ProxyPatchRequest request, RequestOptions requestOptions) {
+    public CompletableFuture<ProxyResponse> patch(HttpUrl url, ProxyPatchRequest request) {
+        return patch(url.toString(), request);
+    }
+
+    /**
+     * Forward an authenticated PATCH request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> patch(
+            String url, ProxyPatchRequest request, RequestOptions requestOptions) {
         final String url64 = encodeUrl(url);
         return this.rawClient.patch(url64, request, requestOptions).thenApply(response -> response.body());
     }
+
+    /**
+     * Forward an authenticated PATCH request to an external API using an external user's account credentials
+     */
+    public CompletableFuture<ProxyResponse> patch(
+            HttpUrl url, ProxyPatchRequest request, RequestOptions requestOptions) {
+        return patch(url.toString(), request, requestOptions);
+    }
 }