Switch to camelCase (#82)

Add a serialization layer between the client interfaces
and the API, so that the former can have camelCase 
arguments and return types while being compatible with
the API snake_case convention.

---------

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

@@ -7,6 +7,7 @@
 .gitignore
 .prettierignore
 .prettierrc.yml
+package.json
 
 # Our own license
 LICENSE

MIGRATE.md

@@ -835,7 +835,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-rc.6 --save
+npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.7 --save
 ```
 
 Then, in your code, you can import the new SDK with the alias:

README.md

@@ -35,7 +35,7 @@ const client = new PipedreamClient({
 });
 await client.actions.run({
     id: "id",
-    external_user_id: "external_user_id",
+    externalUserId: "external_user_id",
 });
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pipedream/sdk",
-    "version": "2.0.0-rc.6",
+    "version": "2.0.0-rc.7",
     "private": false,
     "repository": "github:PipedreamHQ/pipedream-sdk-typescript",
     "type": "commonjs",
@@ -30,6 +30,18 @@
             "import": "./dist/esm/browser/index.mjs",
             "default": "./dist/esm/browser/index.mjs"
         },
+        "./serialization": {
+            "types": "./dist/cjs/serialization/index.d.ts",
+            "import": {
+                "types": "./dist/esm/serialization/index.d.mts",
+                "default": "./dist/esm/serialization/index.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/serialization/index.d.ts",
+                "default": "./dist/cjs/serialization/index.js"
+            },
+            "default": "./dist/cjs/serialization/index.js"
+        },
         "./server": {
             "types": "./dist/cjs/index.d.ts",
             "import": {

src/Client.ts

@@ -73,8 +73,8 @@ export class PipedreamClient {
                     "x-pd-environment": _options?.projectEnvironment,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@pipedream/sdk",
-                    "X-Fern-SDK-Version": "2.0.0-rc.6",
-                    "User-Agent": "@pipedream/sdk/2.0.0-rc.6",
+                    "X-Fern-SDK-Version": "2.0.0-rc.7",
+                    "User-Agent": "@pipedream/sdk/2.0.0-rc.7",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

src/api/resources/accounts/client/Client.ts

@@ -6,6 +6,7 @@ import * as environments from "../../../../environments.js";
 import * as core from "../../../../core/index.js";
 import * as Pipedream from "../../../index.js";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as serializers from "../../../../serialization/index.js";
 import * as errors from "../../../../errors/index.js";
 
 export declare namespace Accounts {
@@ -59,15 +60,7 @@ export class Accounts {
             async (
                 request: Pipedream.AccountsListRequest,
             ): Promise<core.WithRawResponse<Pipedream.ListAccountsResponse>> => {
-                const {
-                    app_id: appId,
-                    external_user_id: externalUserId,
-                    oauth_app_id: oauthAppId,
-                    after,
-                    before,
-                    limit,
-                    include_credentials: includeCredentials,
-                } = request;
+                const { appId, externalUserId, oauthAppId, after, before, limit, includeCredentials } = request;
                 const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
                 if (appId != null) {
                     _queryParams["app_id"] = appId;
@@ -114,7 +107,13 @@ export class Accounts {
                 });
                 if (_response.ok) {
                     return {
-                        data: _response.body as Pipedream.ListAccountsResponse,
+                        data: serializers.ListAccountsResponse.parseOrThrow(_response.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }),
                         rawResponse: _response.rawResponse,
                     };
                 }
@@ -149,11 +148,11 @@ export class Accounts {
             response: dataWithRawResponse.data,
             rawResponse: dataWithRawResponse.rawResponse,
             hasNextPage: (response) =>
-                response?.page_info?.end_cursor != null &&
-                !(typeof response?.page_info?.end_cursor === "string" && response?.page_info?.end_cursor === ""),
+                response?.pageInfo?.endCursor != null &&
+                !(typeof response?.pageInfo?.endCursor === "string" && response?.pageInfo?.endCursor === ""),
             getItems: (response) => response?.data ?? [],
             loadPage: (response) => {
-                return list(core.setObjectProperty(request, "after", response?.page_info?.end_cursor));
+                return list(core.setObjectProperty(request, "after", response?.pageInfo?.endCursor));
             },
         });
     }
@@ -164,9 +163,9 @@ export class Accounts {
      *
      * @example
      *     await client.accounts.create({
-     *         app_slug: "app_slug",
-     *         cfmap_json: "cfmap_json",
-     *         connect_token: "connect_token"
+     *         appSlug: "app_slug",
+     *         cfmapJson: "cfmap_json",
+     *         connectToken: "connect_token"
      *     })
      */
     public create(
@@ -180,7 +179,7 @@ export class Accounts {
         request: Pipedream.CreateAccountOpts,
         requestOptions?: Accounts.RequestOptions,
     ): Promise<core.WithRawResponse<Pipedream.Account>> {
-        const { app_id: appId, external_user_id: externalUserId, oauth_app_id: oauthAppId, ..._body } = request;
+        const { appId, externalUserId, oauthAppId, ..._body } = request;
         const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
         if (appId != null) {
             _queryParams["app_id"] = appId;
@@ -213,13 +212,25 @@ export class Accounts {
             contentType: "application/json",
             queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
             requestType: "json",
-            body: _body,
+            body: serializers.CreateAccountOpts.jsonOrThrow(_body, {
+                unrecognizedObjectKeys: "strip",
+                omitUndefined: true,
+            }),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             abortSignal: requestOptions?.abortSignal,
         });
         if (_response.ok) {
-            return { data: _response.body as Pipedream.Account, rawResponse: _response.rawResponse };
+            return {
+                data: serializers.Account.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                }),
+                rawResponse: _response.rawResponse,
+            };
         }
 
         if (_response.error.reason === "status-code") {
@@ -270,7 +281,7 @@ export class Accounts {
         request: Pipedream.AccountsRetrieveRequest = {},
         requestOptions?: Accounts.RequestOptions,
     ): Promise<core.WithRawResponse<Pipedream.Account>> {
-        const { include_credentials: includeCredentials } = request;
+        const { includeCredentials } = request;
         const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
         if (includeCredentials != null) {
             _queryParams["include_credentials"] = includeCredentials.toString();
@@ -298,7 +309,16 @@ export class Accounts {
             abortSignal: requestOptions?.abortSignal,
         });
         if (_response.ok) {
-            return { data: _response.body as Pipedream.Account, rawResponse: _response.rawResponse };
+            return {
+                data: serializers.Account.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                }),
+                rawResponse: _response.rawResponse,
+            };
         }
 
         if (_response.error.reason === "status-code") {

src/api/resources/accounts/client/requests/AccountsListRequest.ts

@@ -10,12 +10,12 @@ export interface AccountsListRequest {
     /**
      * The app slug or ID to filter accounts by.
      */
-    app_id?: string;
-    external_user_id?: string;
+    appId?: string;
+    externalUserId?: string;
     /**
      * The OAuth app ID to filter by, if applicable
      */
-    oauth_app_id?: string;
+    oauthAppId?: string;
     /**
      * The cursor to start from for pagination
      */
@@ -31,5 +31,5 @@ export interface AccountsListRequest {
     /**
      * Whether to retrieve the account's credentials or not
      */
-    include_credentials?: boolean;
+    includeCredentials?: boolean;
 }

src/api/resources/accounts/client/requests/AccountsRetrieveRequest.ts

@@ -10,5 +10,5 @@ export interface AccountsRetrieveRequest {
     /**
      * Whether to retrieve the account's credentials or not
      */
-    include_credentials?: boolean;
+    includeCredentials?: boolean;
 }

src/api/resources/accounts/client/requests/CreateAccountOpts.ts

@@ -5,27 +5,27 @@
 /**
  * @example
  *     {
- *         app_slug: "app_slug",
- *         cfmap_json: "cfmap_json",
- *         connect_token: "connect_token"
+ *         appSlug: "app_slug",
+ *         cfmapJson: "cfmap_json",
+ *         connectToken: "connect_token"
  *     }
  */
 export interface CreateAccountOpts {
     /**
      * The app slug or ID to filter accounts by.
      */
-    app_id?: string;
-    external_user_id?: string;
+    appId?: string;
+    externalUserId?: string;
     /**
      * The OAuth app ID to filter by, if applicable
      */
-    oauth_app_id?: string;
+    oauthAppId?: string;
     /** The app slug for the account */
-    app_slug: string;
+    appSlug: string;
     /** JSON string containing the custom fields mapping */
-    cfmap_json: string;
+    cfmapJson: string;
     /** The connect token for authentication */
-    connect_token: string;
+    connectToken: string;
     /** Optional name for the account */
     name?: string;
 }