SDK regeneration

Author: fern-api[bot]

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up node
         uses: actions/setup-node@v3
@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up node
         uses: actions/setup-node@v3
@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up node
         uses: actions/setup-node@v3
       - name: Install dependencies

README.md

@@ -2,9 +2,14 @@
 
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Ftruefoundry%2Ftruefoundry-typescript-sdk)
 [![npm shield](https://img.shields.io/npm/v/truefoundry-sdk)](https://www.npmjs.com/package/truefoundry-sdk)
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/truefoundry/truefoundry-typescript-sdk)
 
-The Truefoundry TypeScript library provides convenient access to the Truefoundry API from TypeScript.
+This library provides convenient access to the TrueFoundry API.
+
+> [!tip]
+> You can ask questions about this SDK using DeepWiki
+>
+> - Python: [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/truefoundry/truefoundry-python-sdk)
+> - TypeScript: [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/truefoundry/truefoundry-typescript-sdk)
 
 ## Installation
 
@@ -70,6 +75,7 @@ try {
         console.log(err.statusCode);
         console.log(err.message);
         console.log(err.body);
+        console.log(err.rawResponse);
     }
 }
 ```
@@ -156,6 +162,18 @@ const response = await client.applications.list(..., {
 controller.abort(); // aborts the request
 ```
 
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.applications.list(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
 ### Runtime Compatibility
 
 The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
@@ -170,7 +188,7 @@ runtimes:
 
 ### Customizing Fetch Client
 
-The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
 unsupported environment, this provides a way for you to break glass and ensure the SDK works.
 
 ```typescript

package.json

@@ -39,5 +39,6 @@
         "fs": false,
         "os": false,
         "path": false
-    }
+    },
+    "packageManager": "[email protected]"
 }

reference.md

@@ -1171,78 +1171,6 @@ await client.virtualAccounts.delete("id");
 
 ## Secrets
 
-<details><summary><code>client.secrets.<a href="/src/api/resources/secrets/client/Client.ts">list</a>({ ...params }) -> core.Page<TrueFoundry.Secret></code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-List secrets associated with a user filtered with optional parameters passed in the body.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-const response = await client.secrets.list();
-for await (const item of response) {
-    console.log(item);
-}
-
-// Or you can manually iterate page-by-page
-const page = await client.secrets.list();
-while (page.hasNextPage()) {
-    page = page.getNextPage();
-}
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `TrueFoundry.ListSecretsRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Secrets.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.secrets.<a href="/src/api/resources/secrets/client/Client.ts">get</a>(id) -> TrueFoundry.GetSecretResponse</code></summary>
 <dl>
 <dd>
@@ -1255,7 +1183,7 @@ while (page.hasNextPage()) {
 <dl>
 <dd>
 
-Get Secret associated with provided id
+Get Secret associated with provided id. The secret value is not returned if the control plane has `DISABLE_SECRET_VALUE_VIEW` set
 
 </dd>
 </dl>
@@ -1383,7 +1311,7 @@ await client.secrets.delete("id");
 <dl>
 <dd>
 
-List the secret groups associated with a user along with the associated secrets for each group. Filtered with the options passed in the query fields.
+List the secret groups associated with a user along with the associated secrets for each group. Filtered with the options passed in the query fields. Note: This method does not return the secret values of the <em>associatedSecrets</em> in the response. A separate API call to `/v1/secrets/{id}` should be made to fetch the associated secret value.
 
 </dd>
 </dl>
@@ -1461,7 +1389,7 @@ while (page.hasNextPage()) {
 <dl>
 <dd>
 
-Creates a secret group with secrets in it. A secret version for each of the created secret is created with version number as 1. The returned secret group does not have any secrets in the <em>associatedSecrets</em> field. A separate API call should be made to fetch the associated secrets.
+Creates a secret group with secrets in it. A secret version for each of the created secret is created with version number as 1. The returned secret group does not have any secret values in the <em>associatedSecrets</em> field. A separate API call to `/v1/secrets/{id}` should be made to fetch the associated secret value.
 
 </dd>
 </dl>
@@ -1533,7 +1461,7 @@ await client.secretGroups.create({
 <dl>
 <dd>
 
-Get Secret Group associated with provided secretGroup id
+Get Secret Group by id. This method does not return the secret values of the <em>associatedSecrets</em> in the response. A separate API call to `/v1/secrets/{id}` should be made to fetch the associated secret value.
 
 </dd>
 </dl>
@@ -1596,7 +1524,7 @@ await client.secretGroups.get("id");
 <dl>
 <dd>
 
-Updates the secrets in a secret group with new values. A new secret version is created for every secret that has a modified value. Returns the updated secret group. The returned secret group does not have any secrets in the <em>associatedSecrets</em> field. A separate API call should be made to fetch the associated secrets.
+Updates the secrets in a secret group with new values. A new secret version is created for every secret that has a modified value and any omitted secrets are deleted. The returned updated secret group does not have any secret values in the <em>associatedSecrets</em> field. A separate API call to `/v1/secrets/{id}` should be made to fetch the associated secret value.
 
 </dd>
 </dl>
@@ -1725,69 +1653,6 @@ await client.secretGroups.delete("id");
 </dl>
 </details>
 
-<details><summary><code>client.secretGroups.<a href="/src/api/resources/secretGroups/client/Client.ts">listSecrets</a>(id) -> TrueFoundry.Secret[]</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-List Secrets associated with a Secret Group.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.secretGroups.listSecrets("id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**id:** `string` — Secret Id of the secret group.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `SecretGroups.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Clusters
 
 <details><summary><code>client.clusters.<a href="/src/api/resources/clusters/client/Client.ts">list</a>({ ...params }) -> core.Page<TrueFoundry.Cluster></code></summary>

src/api/errors/BadRequestError.ts

@@ -3,13 +3,15 @@
  */
 
 import * as errors from "../../errors/index";
+import * as core from "../../core";
 
 export class BadRequestError extends errors.TrueFoundryError {
-    constructor(body?: unknown) {
+    constructor(body?: unknown, rawResponse?: core.RawResponse) {
         super({
             message: "BadRequestError",
             statusCode: 400,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, BadRequestError.prototype);
     }

src/api/errors/ConflictError.ts

@@ -4,13 +4,15 @@
 
 import * as errors from "../../errors/index";
 import * as TrueFoundry from "../index";
+import * as core from "../../core";
 
 export class ConflictError extends errors.TrueFoundryError {
-    constructor(body: TrueFoundry.HttpError) {
+    constructor(body: TrueFoundry.HttpError, rawResponse?: core.RawResponse) {
         super({
             message: "ConflictError",
             statusCode: 409,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, ConflictError.prototype);
     }

src/api/errors/ExpectationFailedError.ts

@@ -4,13 +4,15 @@
 
 import * as errors from "../../errors/index";
 import * as TrueFoundry from "../index";
+import * as core from "../../core";
 
 export class ExpectationFailedError extends errors.TrueFoundryError {
-    constructor(body: TrueFoundry.HttpError) {
+    constructor(body: TrueFoundry.HttpError, rawResponse?: core.RawResponse) {
         super({
             message: "ExpectationFailedError",
             statusCode: 417,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, ExpectationFailedError.prototype);
     }

src/api/errors/FailedDependencyError.ts

@@ -4,13 +4,15 @@
 
 import * as errors from "../../errors/index";
 import * as TrueFoundry from "../index";
+import * as core from "../../core";
 
 export class FailedDependencyError extends errors.TrueFoundryError {
-    constructor(body: TrueFoundry.HttpError) {
+    constructor(body: TrueFoundry.HttpError, rawResponse?: core.RawResponse) {
         super({
             message: "FailedDependencyError",
             statusCode: 424,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, FailedDependencyError.prototype);
     }

src/api/errors/ForbiddenError.ts

@@ -4,13 +4,15 @@
 
 import * as errors from "../../errors/index";
 import * as TrueFoundry from "../index";
+import * as core from "../../core";
 
 export class ForbiddenError extends errors.TrueFoundryError {
-    constructor(body: TrueFoundry.HttpError) {
+    constructor(body: TrueFoundry.HttpError, rawResponse?: core.RawResponse) {
         super({
             message: "ForbiddenError",
             statusCode: 403,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, ForbiddenError.prototype);
     }

src/api/errors/MethodNotAllowedError.ts

@@ -3,13 +3,15 @@
  */
 
 import * as errors from "../../errors/index";
+import * as core from "../../core";
 
 export class MethodNotAllowedError extends errors.TrueFoundryError {
-    constructor(body?: unknown) {
+    constructor(body?: unknown, rawResponse?: core.RawResponse) {
         super({
             message: "MethodNotAllowedError",
             statusCode: 405,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, MethodNotAllowedError.prototype);
     }