Skip to content

Commit

Permalink
readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
ismaelrumzan committed Nov 22, 2024
1 parent e26e7b7 commit faa0562
Show file tree
Hide file tree
Showing 6 changed files with 1,010 additions and 0 deletions.
809 changes: 809 additions & 0 deletions README.md

Large diffs are not rendered by default.

51 changes: 51 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@


## 2024-09-12 00:25:13
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.2 (2.415.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v14.0.0-canary.0] packages/sdk
### Releases
- [NPM v14.0.0-canary.0] https://www.npmjs.com/package/@vercel/sdk/v/14.0.0-canary.0 - packages/sdk

## 2024-09-24 21:05:38
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.402.12 (2.422.15) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v14.0.0-canary.2] packages/sdk
### Releases
- [NPM v14.0.0-canary.2] https://www.npmjs.com/package/@vercel/sdk/v/14.0.0-canary.2 - packages/sdk

## 2024-09-27 16:16:59
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.404.4 (2.426.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v14.0.0-canary.3] packages/sdk
### Releases
- [NPM v14.0.0-canary.3] https://www.npmjs.com/package/@vercel/sdk/v/14.0.0-canary.3 - packages/sdk

## 2024-11-06 15:50:38
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.431.0 (2.451.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v14.0.0-canary.4] packages/sdk
### Releases
- [NPM v14.0.0-canary.4] https://www.npmjs.com/package/@vercel/sdk/v/14.0.0-canary.4 - packages/sdk

## 2024-11-14 19:36:49
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.439.0 (2.457.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v14.0.0-canary.6] packages/sdk
### Releases
- [NPM v14.0.0-canary.6] https://www.npmjs.com/package/@vercel/sdk/v/14.0.0-canary.6 - packages/sdk
22 changes: 22 additions & 0 deletions RUNTIMES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Supported JavaScript runtimes

This SDK is intended to be used in JavaScript runtimes that support the following features:

* [Web Fetch API][web-fetch]
* [Web Streams API][web-streams] and in particular `ReadableStream`
* [Async iterables][async-iter] using `Symbol.asyncIterator`

[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols

Runtime environments that are explicitly supported are:

- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
- Node.js active and maintenance LTS releases
- Currently, this is v18 and v20
- Bun v1 and above
- Deno v1.39
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])

[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
61 changes: 61 additions & 0 deletions USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!-- Start SDK Example Usage [usage] -->
### List deployments

List deployments under the authenticated user or team.

```typescript
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
const result = await vercel.deployments.getDeployments({
app: "docs",
from: 1612948664566,
limit: 10,
projectId: "QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY",
target: "production",
to: 1612948664566,
users: "kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY",
since: 1540095775941,
until: 1540095775951,
state: "BUILDING,READY",
});

// Handle the result
console.log(result);
}

run();

```

### Update an existing project

Update the fields of a project using either its name or id.

```typescript
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
const result = await vercel.projects.updateProject({
idOrName: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
requestBody: {
name: "a-project-name",
},
});

// Handle the result
console.log(result);
}

run();

```
<!-- End SDK Example Usage [usage] -->
27 changes: 27 additions & 0 deletions jsr.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@


{
"name": "@vercel/sdk",
"version": "14.0.0-canary.6",
"exports": {
".": "./src/index.ts",
"./models/errors": "./src/models/errors/index.ts",
"./models/components": "./src/models/components/index.ts",
"./models/operations": "./src/models/operations/index.ts",
"./lib/config": "./src/lib/config.ts",
"./lib/http": "./src/lib/http.ts",
"./lib/retries": "./src/lib/retries.ts",
"./lib/sdks": "./src/lib/sdks.ts",
"./types": "./src/types/index.ts"
},
"publish": {
"include": [
"LICENSE",
"README.md",
"RUNTIMES.md",
"USAGE.md",
"jsr.json",
"src/**/*.ts"
]
}
}
40 changes: 40 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"compilerOptions": {
"incremental": true,
"tsBuildInfoFile": ".tsbuildinfo",
"target": "ES2018",
"lib": ["ES2022", "DOM", "DOM.Iterable"],

"module": "Node16",
"moduleResolution": "Node16",

"allowJs": true,

"declaration": true,
"declarationMap": true,
"sourceMap": true,
"outDir": "esm",


// https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json
"strict": true,
"allowUnusedLabels": false,
"allowUnreachableCode": false,
"exactOptionalPropertyTypes": true,
"useUnknownInCatchVariables": true,
"noFallthroughCasesInSwitch": true,
"noImplicitOverride": true,
"noImplicitReturns": true,
"noPropertyAccessFromIndexSignature": true,
"noUncheckedIndexedAccess": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"isolatedModules": true,
"checkJs": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
},
"include": ["src"],
"exclude": ["node_modules"]
}

0 comments on commit faa0562

Please sign in to comment.