Add Connect Usage API and token scope (#215)

* Add a new usage resource with a list method
  to retrieve Connect usage records for a given
  time window.
* `CreateTokenOpts` now supports:
  - `expiresIn`: set a custom TTL in seconds (max 4 hours)
  - `scope`: restrict token permissions with
    space-separated scopes (defaults to `connect:*`)

Author: fern-api[bot]

README.md

@@ -40,7 +40,7 @@ Add the dependency in your `pom.xml` file:
 <dependency>
   <groupId>com.pipedream</groupId>
   <artifactId>pipedream</artifactId>
-  <version>1.1.5</version>
+  <version>1.1.6</version>
 </dependency>
 ```
 
@@ -119,7 +119,7 @@ try{
 
 ### Custom Client
 
-This SDK is built to work with any instance of `OkHttpClient`. By default, if no client is provided, the SDK will construct one.
+This SDK is built to work with any instance of `OkHttpClient`. By default, if no client is provided, the SDK will construct one. 
 However, you can pass your own client like so:
 
 ```java

build.gradle

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

src/main/java/com/pipedream/api/AsyncBaseClient.java

@@ -17,6 +17,7 @@
 import com.pipedream.api.resources.proxy.AsyncProxyClient;
 import com.pipedream.api.resources.tokens.AsyncTokensClient;
 import com.pipedream.api.resources.triggers.AsyncTriggersClient;
+import com.pipedream.api.resources.usage.AsyncUsageClient;
 import com.pipedream.api.resources.users.AsyncUsersClient;
 import java.util.function.Supplier;
 
@@ -47,6 +48,8 @@ public class AsyncBaseClient {
 
     protected final Supplier<AsyncTokensClient> tokensClient;
 
+    protected final Supplier<AsyncUsageClient> usageClient;
+
     protected final Supplier<AsyncOauthTokensClient> oauthTokensClient;
 
     public AsyncBaseClient(ClientOptions clientOptions) {
@@ -63,6 +66,7 @@ public AsyncBaseClient(ClientOptions clientOptions) {
         this.fileStashClient = Suppliers.memoize(() -> new AsyncFileStashClient(clientOptions));
         this.proxyClient = Suppliers.memoize(() -> new AsyncProxyClient(clientOptions));
         this.tokensClient = Suppliers.memoize(() -> new AsyncTokensClient(clientOptions));
+        this.usageClient = Suppliers.memoize(() -> new AsyncUsageClient(clientOptions));
         this.oauthTokensClient = Suppliers.memoize(() -> new AsyncOauthTokensClient(clientOptions));
     }
 
@@ -114,6 +118,10 @@ public AsyncTokensClient tokens() {
         return this.tokensClient.get();
     }
 
+    public AsyncUsageClient usage() {
+        return this.usageClient.get();
+    }
+
     public AsyncOauthTokensClient oauthTokens() {
         return this.oauthTokensClient.get();
     }

src/main/java/com/pipedream/api/BaseClient.java

@@ -17,6 +17,7 @@
 import com.pipedream.api.resources.proxy.ProxyClient;
 import com.pipedream.api.resources.tokens.TokensClient;
 import com.pipedream.api.resources.triggers.TriggersClient;
+import com.pipedream.api.resources.usage.UsageClient;
 import com.pipedream.api.resources.users.UsersClient;
 import java.util.function.Supplier;
 
@@ -47,6 +48,8 @@ public class BaseClient {
 
     protected final Supplier<TokensClient> tokensClient;
 
+    protected final Supplier<UsageClient> usageClient;
+
     protected final Supplier<OauthTokensClient> oauthTokensClient;
 
     public BaseClient(ClientOptions clientOptions) {
@@ -63,6 +66,7 @@ public BaseClient(ClientOptions clientOptions) {
         this.fileStashClient = Suppliers.memoize(() -> new FileStashClient(clientOptions));
         this.proxyClient = Suppliers.memoize(() -> new ProxyClient(clientOptions));
         this.tokensClient = Suppliers.memoize(() -> new TokensClient(clientOptions));
+        this.usageClient = Suppliers.memoize(() -> new UsageClient(clientOptions));
         this.oauthTokensClient = Suppliers.memoize(() -> new OauthTokensClient(clientOptions));
     }
 
@@ -114,6 +118,10 @@ public TokensClient tokens() {
         return this.tokensClient.get();
     }
 
+    public UsageClient usage() {
+        return this.usageClient.get();
+    }
+
     public OauthTokensClient oauthTokens() {
         return this.oauthTokensClient.get();
     }

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.5");
+                put("User-Agent", "com.pipedream:pipedream/1.1.6");
                 put("X-Fern-Language", "JAVA");
                 put("X-Fern-SDK-Name", "com.pipedream.fern:api-sdk");
-                put("X-Fern-SDK-Version", "1.1.5");
+                put("X-Fern-SDK-Version", "1.1.6");
             }
         });
         this.headerSuppliers = headerSuppliers;

src/main/java/com/pipedream/api/resources/oauthtokens/requests/CreateOAuthTokenOpts.java

@@ -53,7 +53,7 @@ public String getClientSecret() {
     }
 
     /**
-     * @return Optional space-separated scopes for the access token. Defaults to '*'.
+     * @return Optional space-separated scopes for the access token. Defaults to <code>*</code>.
      */
     @JsonProperty("scope")
     public Optional<String> getScope() {
@@ -103,7 +103,7 @@ public interface _FinalStage {
         CreateOAuthTokenOpts build();
 
         /**
-         * <p>Optional space-separated scopes for the access token. Defaults to '*'.</p>
+         * <p>Optional space-separated scopes for the access token. Defaults to <code>*</code>.</p>
          */
         _FinalStage scope(Optional<String> scope);
 
@@ -146,7 +146,7 @@ public _FinalStage clientSecret(@NotNull String clientSecret) {
         }
 
         /**
-         * <p>Optional space-separated scopes for the access token. Defaults to '*'.</p>
+         * <p>Optional space-separated scopes for the access token. Defaults to <code>*</code>.</p>
          * @return Reference to {@code this} so that method calls can be chained together.
          */
         @java.lang.Override
@@ -156,7 +156,7 @@ public _FinalStage scope(String scope) {
         }
 
         /**
-         * <p>Optional space-separated scopes for the access token. Defaults to '*'.</p>
+         * <p>Optional space-separated scopes for the access token. Defaults to <code>*</code>.</p>
          */
         @java.lang.Override
         @JsonSetter(value = "scope", nulls = Nulls.SKIP)

src/main/java/com/pipedream/api/resources/tokens/requests/CreateTokenOpts.java

@@ -26,8 +26,12 @@ public final class CreateTokenOpts {
 
     private final Optional<String> errorRedirectUri;
 
+    private final Optional<Integer> expiresIn;
+
     private final String externalUserId;
 
+    private final Optional<String> scope;
+
     private final Optional<String> successRedirectUri;
 
     private final Optional<String> webhookUri;
@@ -37,13 +41,17 @@ public final class CreateTokenOpts {
     private CreateTokenOpts(
             Optional<List<String>> allowedOrigins,
             Optional<String> errorRedirectUri,
+            Optional<Integer> expiresIn,
             String externalUserId,
+            Optional<String> scope,
             Optional<String> successRedirectUri,
             Optional<String> webhookUri,
             Map<String, Object> additionalProperties) {
         this.allowedOrigins = allowedOrigins;
         this.errorRedirectUri = errorRedirectUri;
+        this.expiresIn = expiresIn;
         this.externalUserId = externalUserId;
+        this.scope = scope;
         this.successRedirectUri = successRedirectUri;
         this.webhookUri = webhookUri;
         this.additionalProperties = additionalProperties;
@@ -65,6 +73,14 @@ public Optional<String> getErrorRedirectUri() {
         return errorRedirectUri;
     }
 
+    /**
+     * @return Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.
+     */
+    @JsonProperty("expires_in")
+    public Optional<Integer> getExpiresIn() {
+        return expiresIn;
+    }
+
     /**
      * @return Your end user ID, for whom you're creating the token
      */
@@ -73,6 +89,14 @@ public String getExternalUserId() {
         return externalUserId;
     }
 
+    /**
+     * @return Space-separated scopes to restrict token permissions. Defaults to 'connect:*' if not specified. See https://pipedream.com/docs/connect/api-reference/authentication#connect-token-scopes for more information.
+     */
+    @JsonProperty("scope")
+    public Optional<String> getScope() {
+        return scope;
+    }
+
     /**
      * @return URI to redirect to on success
      */
@@ -103,7 +127,9 @@ public Map<String, Object> getAdditionalProperties() {
     private boolean equalTo(CreateTokenOpts other) {
         return allowedOrigins.equals(other.allowedOrigins)
                 && errorRedirectUri.equals(other.errorRedirectUri)
+                && expiresIn.equals(other.expiresIn)
                 && externalUserId.equals(other.externalUserId)
+                && scope.equals(other.scope)
                 && successRedirectUri.equals(other.successRedirectUri)
                 && webhookUri.equals(other.webhookUri);
     }
@@ -113,7 +139,9 @@ public int hashCode() {
         return Objects.hash(
                 this.allowedOrigins,
                 this.errorRedirectUri,
+                this.expiresIn,
                 this.externalUserId,
+                this.scope,
                 this.successRedirectUri,
                 this.webhookUri);
     }
@@ -153,6 +181,20 @@ public interface _FinalStage {
 
         _FinalStage errorRedirectUri(String errorRedirectUri);
 
+        /**
+         * <p>Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.</p>
+         */
+        _FinalStage expiresIn(Optional<Integer> expiresIn);
+
+        _FinalStage expiresIn(Integer expiresIn);
+
+        /**
+         * <p>Space-separated scopes to restrict token permissions. Defaults to 'connect:*' if not specified. See https://pipedream.com/docs/connect/api-reference/authentication#connect-token-scopes for more information.</p>
+         */
+        _FinalStage scope(Optional<String> scope);
+
+        _FinalStage scope(String scope);
+
         /**
          * <p>URI to redirect to on success</p>
          */
@@ -176,6 +218,10 @@ public static final class Builder implements ExternalUserIdStage, _FinalStage {
 
         private Optional<String> successRedirectUri = Optional.empty();
 
+        private Optional<String> scope = Optional.empty();
+
+        private Optional<Integer> expiresIn = Optional.empty();
+
         private Optional<String> errorRedirectUri = Optional.empty();
 
         private Optional<List<String>> allowedOrigins = Optional.empty();
@@ -189,7 +235,9 @@ private Builder() {}
         public Builder from(CreateTokenOpts other) {
             allowedOrigins(other.getAllowedOrigins());
             errorRedirectUri(other.getErrorRedirectUri());
+            expiresIn(other.getExpiresIn());
             externalUserId(other.getExternalUserId());
+            scope(other.getScope());
             successRedirectUri(other.getSuccessRedirectUri());
             webhookUri(other.getWebhookUri());
             return this;
@@ -247,6 +295,46 @@ public _FinalStage successRedirectUri(Optional<String> successRedirectUri) {
             return this;
         }
 
+        /**
+         * <p>Space-separated scopes to restrict token permissions. Defaults to 'connect:*' if not specified. See https://pipedream.com/docs/connect/api-reference/authentication#connect-token-scopes for more information.</p>
+         * @return Reference to {@code this} so that method calls can be chained together.
+         */
+        @java.lang.Override
+        public _FinalStage scope(String scope) {
+            this.scope = Optional.ofNullable(scope);
+            return this;
+        }
+
+        /**
+         * <p>Space-separated scopes to restrict token permissions. Defaults to 'connect:*' if not specified. See https://pipedream.com/docs/connect/api-reference/authentication#connect-token-scopes for more information.</p>
+         */
+        @java.lang.Override
+        @JsonSetter(value = "scope", nulls = Nulls.SKIP)
+        public _FinalStage scope(Optional<String> scope) {
+            this.scope = scope;
+            return this;
+        }
+
+        /**
+         * <p>Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.</p>
+         * @return Reference to {@code this} so that method calls can be chained together.
+         */
+        @java.lang.Override
+        public _FinalStage expiresIn(Integer expiresIn) {
+            this.expiresIn = Optional.ofNullable(expiresIn);
+            return this;
+        }
+
+        /**
+         * <p>Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.</p>
+         */
+        @java.lang.Override
+        @JsonSetter(value = "expires_in", nulls = Nulls.SKIP)
+        public _FinalStage expiresIn(Optional<Integer> expiresIn) {
+            this.expiresIn = expiresIn;
+            return this;
+        }
+
         /**
          * <p>URI to redirect to on error</p>
          * @return Reference to {@code this} so that method calls can be chained together.
@@ -292,7 +380,9 @@ public CreateTokenOpts build() {
             return new CreateTokenOpts(
                     allowedOrigins,
                     errorRedirectUri,
+                    expiresIn,
                     externalUserId,
+                    scope,
                     successRedirectUri,
                     webhookUri,
                     additionalProperties);