Better README example (#64)

* Update `README.md` with a better example endpoint
* Clean up `.fernignore` so that it doesn't wipe our work
* Fix incorrect versions

---------

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: Jay Vercellone <[email protected]>

Author: fern-api[bot]

.fernignore

@@ -13,14 +13,29 @@ LICENSE
 # References doc (we have additional use cases)
 reference.md
 
+# Migration doc
+MIGRATE.md
+
 # Custom Pipedream client files
 src/api/resources/index.ts
 src/api/types/index.ts
 src/index.ts
 src/wrapper
 
 # Custom Proxy files
-src/api/resources/proxy/client/*
+src/api/resources/proxy/client/requests/ProxyPutRequest.ts
+src/api/resources/proxy/client/requests/ProxyGetRequest.ts
+src/api/resources/proxy/client/requests/index.ts
+src/api/resources/proxy/client/requests/ProxyPostRequest.ts
+src/api/resources/proxy/client/requests/ProxyPatchRequest.ts
+src/api/resources/proxy/client/requests/ProxyDeleteRequest.ts
+src/api/resources/proxy/client/Client.ts
+src/api/resources/proxy/client/index.ts
 
 # Custom Workflow files
-src/api/resources/workflows/client/*
+src/api/resources/workflows/client/requests/InvokeWorkflowForExternalUserOpts.ts
+src/api/resources/workflows/client/requests/index.ts
+src/api/resources/workflows/client/requests/InvokeWorkflowOpts.ts
+src/api/resources/workflows/client/Client.ts
+src/api/resources/workflows/client/index.ts
+src/api/types/HTTPAuthType.ts

MIGRATE.md

@@ -740,7 +740,7 @@ incrementally without breaking your existing codebase. To do this, you can
 install the new SDK with an alias:
 
 ```bash
-npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0 --save
+npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.2 --save
 ```
 
 Then, in your code, you can import the new SDK with the alias:

README.md

@@ -33,10 +33,9 @@ const client = new PipedreamClient({
     projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
     projectId: "YOUR_PROJECT_ID",
 });
-await client.accounts.create({
-    app_slug: "app_slug",
-    cfmap_json: "cfmap_json",
-    connect_token: "connect_token",
+await client.actions.run({
+    id: "id",
+    external_user_id: "external_user_id",
 });
 ```
 
@@ -62,7 +61,7 @@ will be thrown.
 import { PipedreamError } from "@pipedream/sdk";
 
 try {
-    await client.accounts.create(...);
+    await client.actions.run(...);
 } catch (err) {
     if (err instanceof PipedreamError) {
         console.log(err.statusCode);
@@ -105,7 +104,7 @@ while (page.hasNextPage()) {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.accounts.create(..., {
+const response = await client.actions.run(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -117,7 +116,7 @@ const response = await client.accounts.create(..., {
 If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
 
 ```typescript
-const response = await client.accounts.create(..., {
+const response = await client.actions.run(..., {
     queryParams: {
         'customQueryParamKey': 'custom query param value'
     }
@@ -139,7 +138,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.accounts.create(..., {
+const response = await client.actions.run(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -149,7 +148,7 @@ const response = await client.accounts.create(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.accounts.create(..., {
+const response = await client.actions.run(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -160,7 +159,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.accounts.create(..., {
+const response = await client.actions.run(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -172,7 +171,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.accounts.create(...).withRawResponse();
+const { data, rawResponse } = await client.actions.run(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);

package.json

@@ -39,17 +39,17 @@
         "test:wire": "jest --selectProjects wire"
     },
     "devDependencies": {
+        "webpack": "^5.97.1",
+        "ts-loader": "^9.5.1",
+        "jest": "^29.7.0",
         "@jest/globals": "^29.7.0",
         "@types/jest": "^29.5.14",
-        "@types/node": "^18.19.70",
-        "jest": "^29.7.0",
+        "ts-jest": "^29.3.4",
         "jest-environment-jsdom": "^29.7.0",
         "msw": "^2.8.4",
+        "@types/node": "^18.19.70",
         "prettier": "^3.4.2",
-        "ts-jest": "^29.3.4",
-        "ts-loader": "^9.5.1",
-        "typescript": "~5.7.2",
-        "webpack": "^5.97.1"
+        "typescript": "~5.7.2"
     },
     "browser": {
         "fs": false,

src/version.ts

@@ -1 +1 @@
-export const SDK_VERSION = "1.7.1";
+export const SDK_VERSION = "2.0.0-rc.2";

yarn.lock

@@ -575,9 +575,9 @@
     "@jridgewell/sourcemap-codec" "^1.4.14"
 
 "@mswjs/interceptors@^0.39.1":
-  version "0.39.3"
-  resolved "https://registry.yarnpkg.com/@mswjs/interceptors/-/interceptors-0.39.3.tgz#d27886db295c9a7dbc41aa229a644bc7bbb04723"
-  integrity sha512-9bw/wBL7pblsnOCIqvn1788S9o4h+cC5HWXg0Xhh0dOzsZ53IyfmBM+FYqpDDPbm0xjCqEqvCITloF3Dm4TXRQ==
+  version "0.39.5"
+  resolved "https://registry.yarnpkg.com/@mswjs/interceptors/-/interceptors-0.39.5.tgz#6f0571493bf76291a60b62234ed0add2c4bd970e"
+  integrity sha512-B9nHSJYtsv79uo7QdkZ/b/WoKm20IkVSmTc/WCKarmDtFwM0dRx2ouEniqwNkzCSLn3fydzKmnMzjtfdOWt3VQ==
   dependencies:
     "@open-draft/deferred-promise" "^2.2.0"
     "@open-draft/logger" "^0.3.0"
@@ -655,11 +655,11 @@
     "@babel/types" "^7.0.0"
 
 "@types/babel__traverse@*", "@types/babel__traverse@^7.0.6":
-  version "7.20.7"
-  resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.20.7.tgz#968cdc2366ec3da159f61166428ee40f370e56c2"
-  integrity sha512-dkO5fhS7+/oos4ciWxyEyjWe48zmG6wbCheo/G2ZnHx4fs3EU6YC6UM8rk56gAjNJ9P3MTH2jo5jb92/K6wbng==
+  version "7.28.0"
+  resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.28.0.tgz#07d713d6cce0d265c9849db0cbe62d3f61f36f74"
+  integrity sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q==
   dependencies:
-    "@babel/types" "^7.20.7"
+    "@babel/types" "^7.28.2"
 
 "@types/cookie@^0.6.0":
   version "0.6.0"
@@ -743,9 +743,9 @@
     undici-types "~7.8.0"
 
 "@types/node@^18.19.70":
-  version "18.19.120"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.120.tgz#07b3bd73875956d5281fa27e6d77a66415f7d455"
-  integrity sha512-WtCGHFXnVI8WHLxDAt5TbnCM4eSE+nI0QN2NJtwzcgMhht2eNz6V9evJrk+lwC8bCY8OWV5Ym8Jz7ZEyGnKnMA==
+  version "18.19.121"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.121.tgz#c50d353ea2d1fb1261a8bbd0bf2850306f5af2b3"
+  integrity sha512-bHOrbyztmyYIi4f1R0s17QsPs1uyyYnGcXeZoGEd227oZjry0q6XQBQxd82X1I57zEfwO8h9Xo+Kl5gX1d9MwQ==
   dependencies:
     undici-types "~5.26.4"
 
@@ -1052,9 +1052,9 @@ babel-plugin-jest-hoist@^29.6.3:
     "@types/babel__traverse" "^7.0.6"
 
 babel-preset-current-node-syntax@^1.0.0:
-  version "1.1.0"
-  resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.1.0.tgz#9a929eafece419612ef4ae4f60b1862ebad8ef30"
-  integrity sha512-ldYss8SbBlWva1bs28q78Ju5Zq1F+8BrqBZZ0VFhLBvhh6lCpC2o3gDJi/5DRLs9FgYZCnmPYIVFU4lRXCkyUw==
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.2.0.tgz#20730d6cdc7dda5d89401cab10ac6a32067acde6"
+  integrity sha512-E/VlAEzRrsLEb2+dv8yp3bo4scof3l9nR4lrld+Iy5NyVqgVYUJnDAmunkhPMisRI32Qc4iRiz425d8vM++2fg==
   dependencies:
     "@babel/plugin-syntax-async-generators" "^7.8.4"
     "@babel/plugin-syntax-bigint" "^7.8.3"
@@ -1160,9 +1160,9 @@ camelcase@^6.2.0:
   integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==
 
 caniuse-lite@^1.0.30001726:
-  version "1.0.30001727"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001727.tgz#22e9706422ad37aa50556af8c10e40e2d93a8b85"
-  integrity sha512-pB68nIHmbN6L/4C6MH1DokyR3bYqFwjaSs/sWDHGj4CTcFtQUQMuJftVwWkXq7mNWOybD3KhUv3oWHoGxgP14Q==
+  version "1.0.30001731"
+  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001731.tgz#277c07416ea4613ec564e5b0ffb47e7b60f32e2f"
+  integrity sha512-lDdp2/wrOmTRWuoB5DpfNkC0rJDU8DqRa6nYL6HK6sytw70QMopt/NIc/9SM7ylItlBWfACXk0tEn37UWM/+mg==
 
 chalk@^4.0.0, chalk@^4.0.2, chalk@^4.1.0:
   version "4.1.2"
@@ -1364,9 +1364,9 @@ ejs@^3.1.10:
     jake "^10.8.5"
 
 electron-to-chromium@^1.5.173:
-  version "1.5.191"
-  resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.191.tgz#8ae49a471447b1ceaf1d4d183a9000082f52363c"
-  integrity sha512-xcwe9ELcuxYLUFqZZxL19Z6HVKcvNkIwhbHUz7L3us6u12yR+7uY89dSl570f/IqNthx8dAw3tojG7i4Ni4tDA==
+  version "1.5.194"
+  resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.194.tgz#05e541c3373ba8d967a65c92bc14d60608908236"
+  integrity sha512-SdnWJwSUot04UR51I2oPD8kuP2VI37/CADR1OHsFOUzZIvfWJBO6q11k5P/uKNyTT3cdOsnyjkrZ+DDShqYqJA==
 
 emittery@^0.13.1:
   version "0.13.1"
@@ -2494,9 +2494,9 @@ npm-run-path@^4.0.1:
     path-key "^3.0.0"
 
 nwsapi@^2.2.2:
-  version "2.2.20"
-  resolved "https://registry.yarnpkg.com/nwsapi/-/nwsapi-2.2.20.tgz#22e53253c61e7b0e7e93cef42c891154bcca11ef"
-  integrity sha512-/ieB+mDe4MrrKMT8z+mQL8klXydZWGR5Dowt4RAGKbJ3kIGEx3X4ljUo+6V73IXtUPWgfOlU5B9MlGxFO5T+cA==
+  version "2.2.21"
+  resolved "https://registry.yarnpkg.com/nwsapi/-/nwsapi-2.2.21.tgz#8df7797079350adda208910d8c33fc4c2d7520c3"
+  integrity sha512-o6nIY3qwiSXl7/LuOU0Dmuctd34Yay0yeuZRLFmDPrrdHpXKFndPj3hM+YEPVHYC5fx2otBx4Ilc/gyYSAUaIA==
 
 once@^1.3.0:
   version "1.4.0"
@@ -3074,9 +3074,9 @@ webpack-sources@^3.3.3:
   integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg==
 
 webpack@^5.97.1:
-  version "5.100.2"
-  resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.100.2.tgz#e2341facf9f7de1d702147c91bcb65b693adf9e8"
-  integrity sha512-QaNKAvGCDRh3wW1dsDjeMdDXwZm2vqq3zn6Pvq4rHOEOGSaUMgOOjG2Y9ZbIGzpfkJk9ZYTHpDqgDfeBDcnLaw==
+  version "5.101.0"
+  resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.101.0.tgz#4b81407ffad9857f81ff03f872e3369b9198cc9d"
+  integrity sha512-B4t+nJqytPeuZlHuIKTbalhljIFXeNRqrUGAQgTGlfOl2lXXKXw+yZu6bicycP+PUlM44CxBjCFD6aciKFT3LQ==
   dependencies:
     "@types/eslint-scope" "^3.7.7"
     "@types/estree" "^1.0.8"