Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
56 changes: 28 additions & 28 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
{
"cliVersion": "5.59.0",
"generatorName": "fernapi/fern-typescript-node-sdk",
"generatorVersion": "3.75.0",
"generatorConfig": {
"allowExtraFields": true,
"allowCustomFetcher": true,
"enableInlineTypes": false,
"fetchSupport": "native",
"fileResponseType": "binary-response",
"formDataSupport": "Node18",
"includeApiReference": true,
"inlineFileProperties": true,
"inlinePathParameters": true,
"namespaceExport": "TrueFoundry",
"noSerdeLayer": false,
"omitUndefined": true,
"retainOriginalCasing": false,
"skipResponseValidation": true,
"streamType": "web",
"useDefaultRequestParameterValues": true
},
"originGitCommit": "32fe60c676059f66eca28ed6042c72b38db2ff04",
"originGitCommitIsDirty": false,
"invokedBy": "ci",
"requestedVersion": "0.0.0",
"ciProvider": "github",
"sdkVersion": "0.0.0"
}
"cliVersion": "5.89.4",
"generatorName": "fernapi/fern-typescript-node-sdk",
"generatorVersion": "3.86.0",
"generatorConfig": {
"allowExtraFields": true,
"allowCustomFetcher": true,
"enableInlineTypes": false,
"fetchSupport": "native",
"fileResponseType": "binary-response",
"formDataSupport": "Node18",
"includeApiReference": true,
"inlineFileProperties": true,
"inlinePathParameters": true,
"namespaceExport": "TrueFoundry",
"noSerdeLayer": false,
"omitUndefined": true,
"retainOriginalCasing": false,
"skipResponseValidation": true,
"streamType": "web",
"useDefaultRequestParameterValues": true
},
"originGitCommit": "ee220d57a9ea7d75b0042756f2870909b45115ab",
"originGitCommitIsDirty": false,
"invokedBy": "ci",
"requestedVersion": "0.0.0",
"ciProvider": "github",
"sdkVersion": "0.0.0"
}
46 changes: 7 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,10 @@ Instantiate and use the client with the following:
```typescript
import { TrueFoundryClient } from "truefoundry-sdk";

const client = new TrueFoundryClient({ environment: "YOUR_BASE_URL", apiKey: "YOUR_API_KEY" });
const client = new TrueFoundryClient({ baseUrl: "YOUR_BASE_URL", apiKey: "YOUR_API_KEY" });
const pageableResponse = await client.applications.list({
limit: 10,
offset: 0,
applicationId: "applicationId",
workspaceId: "workspaceId",
applicationName: "applicationName",
fqn: "fqn",
workspaceFqn: "workspaceFqn",
applicationType: "async-service",
nameSearchQuery: "nameSearchQuery",
environmentId: "environmentId",
clusterId: "clusterId",
applicationSetId: "applicationSetId",
paused: true,
deviceTypeFilter: "cpu",
lastDeployedBySubjects: "lastDeployedBySubjects",
lifecycleStage: "active",
isRecommendationPresentAndVisible: true
offset: 0
});
for await (const item of pageableResponse) {
console.log(item);
Expand All @@ -77,22 +62,7 @@ for await (const item of pageableResponse) {
// Or you can manually iterate page-by-page
let page = await client.applications.list({
limit: 10,
offset: 0,
applicationId: "applicationId",
workspaceId: "workspaceId",
applicationName: "applicationName",
fqn: "fqn",
workspaceFqn: "workspaceFqn",
applicationType: "async-service",
nameSearchQuery: "nameSearchQuery",
environmentId: "environmentId",
clusterId: "clusterId",
applicationSetId: "applicationSetId",
paused: true,
deviceTypeFilter: "cpu",
lastDeployedBySubjects: "lastDeployedBySubjects",
lifecycleStage: "active",
isRecommendationPresentAndVisible: true
offset: 0
});
while (page.hasNextPage()) {
page = page.getNextPage();
Expand All @@ -110,7 +80,7 @@ following namespace:
```typescript
import { TrueFoundry } from "truefoundry-sdk";

const request: TrueFoundry.InternalGetIdFromFqnRequest = {
const request: TrueFoundry.GetIdFromFqnInternalRequest = {
...
};
```
Expand Down Expand Up @@ -142,12 +112,11 @@ List endpoints are paginated. The SDK provides an iterator so that you can simpl
```typescript
import { TrueFoundryClient } from "truefoundry-sdk";

const client = new TrueFoundryClient({ environment: "YOUR_BASE_URL", apiKey: "YOUR_API_KEY" });
const client = new TrueFoundryClient({ baseUrl: "YOUR_BASE_URL", apiKey: "YOUR_API_KEY" });
const pageableResponse = await client.users.list({
limit: 10,
offset: 0,
query: "john@example.com",
showInvalidUsers: true
query: "john@example.com"
});
for await (const item of pageableResponse) {
console.log(item);
Expand All @@ -157,8 +126,7 @@ for await (const item of pageableResponse) {
let page = await client.users.list({
limit: 10,
offset: 0,
query: "john@example.com",
showInvalidUsers: true
query: "john@example.com"
});
while (page.hasNextPage()) {
page = page.getNextPage();
Expand Down
11 changes: 11 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,17 @@
},
"default": "./dist/cjs/api/resources/teams/exports.js"
},
"./gatewayBudgets": {
"import": {
"types": "./dist/esm/api/resources/gatewayBudgets/exports.d.mts",
"default": "./dist/esm/api/resources/gatewayBudgets/exports.mjs"
},
"require": {
"types": "./dist/cjs/api/resources/gatewayBudgets/exports.d.ts",
"default": "./dist/cjs/api/resources/gatewayBudgets/exports.js"
},
"default": "./dist/cjs/api/resources/gatewayBudgets/exports.js"
},
"./personalAccessTokens": {
"import": {
"types": "./dist/esm/api/resources/personalAccessTokens/exports.d.mts",
Expand Down
Loading
Loading