@vercel/sdk 1.2.1 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/sdk",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "author": "Speakeasy",
   "type": "module",
   "main": "./esm/index.js",
@@ -28,6 +28,8 @@
     "url": "https://github.com/vercel/sdk.git"
   },
   "scripts": {
+    "test": "vitest run src --reporter=junit --outputFile=.speakeasy/reports/tests.xml --reporter=default",
+    "check": "npm run test && npm run lint",
     "lint": "eslint --max-warnings=0 src",
     "build": "tsc",
     "prepublishOnly": "npm run build"
@@ -36,12 +38,15 @@
     "zod": ">= 3"
   },
   "devDependencies": {
+    "@types/node": "^18.19.3",
     "@typescript-eslint/eslint-plugin": "^7.7.1",
     "@typescript-eslint/parser": "^7.7.1",
+    "@vitest/ui": "^1.5.0",
     "eslint": "^8.57.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",
     "typescript": "^5.4.5",
+    "vitest": "^1.5.0",
     "zod": "^3.23.4"
   },
   "dependencies": {

package/src/__tests__/accessgroups.test.ts

@@ -0,0 +1,441 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { Vercel } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Access Groups Read Access Group", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("readAccessGroup"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.readAccessGroup({
+    idOrName: "<value>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    isDsyncManaged: false,
+    name: "my-access-group",
+    createdAt: "1588720733602",
+    teamId: "team_123a6c5209bc3778245d011443644c8d27dc2c50",
+    updatedAt: "1588720733602",
+    accessGroupId: "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
+    membersCount: 5,
+    projectsCount: 2,
+  });
+});
+
+test("Access Groups Read Access Group Id", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("readAccessGroup-id"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.readAccessGroup({
+    idOrName: "ag_1a2b3c4d5e6f7g8h9i0j",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    isDsyncManaged: false,
+    name: "my-access-group",
+    createdAt: "1588720733602",
+    teamId: "team_123a6c5209bc3778245d011443644c8d27dc2c50",
+    updatedAt: "1588720733602",
+    accessGroupId: "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
+    membersCount: 5,
+    projectsCount: 2,
+  });
+});
+
+test("Access Groups Read Access Group Name", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("readAccessGroup-name"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.readAccessGroup({
+    idOrName: "My Access Group",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    isDsyncManaged: false,
+    name: "my-access-group",
+    createdAt: "1588720733602",
+    teamId: "team_123a6c5209bc3778245d011443644c8d27dc2c50",
+    updatedAt: "1588720733602",
+    accessGroupId: "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
+    membersCount: 5,
+    projectsCount: 2,
+  });
+});
+
+test("Access Groups Update Access Group", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("updateAccessGroup"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.updateAccessGroup({
+    idOrName: "<value>",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+    requestBody: {
+      name: "My access group",
+      projects: [],
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    name: "my-access-group",
+    createdAt: "1588720733602",
+    teamId: "team_123a6c5209bc3778245d011443644c8d27dc2c50",
+    updatedAt: "1588720733602",
+    accessGroupId: "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
+    membersCount: 5,
+    projectsCount: 2,
+  });
+});
+
+test("Access Groups Delete Access Group", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("deleteAccessGroup"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  await vercel.accessGroups.deleteAccessGroup({
+    idOrName: "<value>",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+});
+
+test("Access Groups List Access Group Members", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("listAccessGroupMembers"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.listAccessGroupMembers({
+    idOrName: "ag_pavWOn1iLObbXLRiwVvzmPrTWyTf",
+    limit: 20,
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    members: [
+      {
+        email: "Jaida_Rogahn@yahoo.com",
+        uid: "<id>",
+        username: "Karianne_Bernier",
+        teamRole: "VIEWER",
+      },
+    ],
+    pagination: {
+      count: 3878.47,
+      next: "<value>",
+    },
+  });
+});
+
+test("Access Groups List Access Groups", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("listAccessGroups"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.listAccessGroups({
+    projectId: "prj_pavWOn1iLObbx3RowVvzmPrTWyTf",
+    search: "example",
+    membersLimit: 20,
+    projectsLimit: 20,
+    limit: 20,
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Access Groups Create Access Group", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("createAccessGroup"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.createAccessGroup({
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+    requestBody: {
+      name: "My access group",
+      projects: [],
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    membersCount: 591.78,
+    projectsCount: 3787.91,
+    name: "my-access-group",
+    createdAt: "1588720733602",
+    teamId: "team_123a6c5209bc3778245d011443644c8d27dc2c50",
+    updatedAt: "1588720733602",
+    accessGroupId: "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
+  });
+});
+
+test("Access Groups List Access Group Projects", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("listAccessGroupProjects"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.listAccessGroupProjects({
+    idOrName: "ag_pavWOn1iLObbXLRiwVvzmPrTWyTf",
+    limit: 20,
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    projects: [],
+    pagination: {
+      count: 7604.02,
+      next: "<value>",
+    },
+  });
+});
+
+test("Access Groups Create Access Group Project", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("createAccessGroupProject"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.createAccessGroupProject({
+    accessGroupIdOrName: "<value>",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+    requestBody: {
+      projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
+      role: "ADMIN",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    teamId: "<id>",
+    accessGroupId: "<id>",
+    projectId: "<id>",
+    role: "PROJECT_VIEWER",
+    createdAt: "<value>",
+    updatedAt: "<value>",
+  });
+});
+
+test("Access Groups Read Access Group Project", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("readAccessGroupProject"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.readAccessGroupProject({
+    accessGroupIdOrName: "<value>",
+    projectId: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    teamId: "<id>",
+    accessGroupId: "<id>",
+    projectId: "<id>",
+    role: "ADMIN",
+    createdAt: "<value>",
+    updatedAt: "<value>",
+  });
+});
+
+test("Access Groups Read Access Group Project Id", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("readAccessGroupProject-id"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.readAccessGroupProject({
+    accessGroupIdOrName: "ag_1a2b3c4d5e6f7g8h9i0j",
+    projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    teamId: "<id>",
+    accessGroupId: "<id>",
+    projectId: "<id>",
+    role: "ADMIN",
+    createdAt: "1706854122023",
+    updatedAt: "1735905380072",
+  });
+});
+
+test("Access Groups Read Access Group Project Name", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("readAccessGroupProject-name"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.readAccessGroupProject({
+    accessGroupIdOrName: "My Access Group",
+    projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    teamId: "<id>",
+    accessGroupId: "<id>",
+    projectId: "<id>",
+    role: "PROJECT_DEVELOPER",
+    createdAt: "1731124284693",
+    updatedAt: "1735836411388",
+  });
+});
+
+test("Access Groups Update Access Group Project", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("updateAccessGroupProject"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.updateAccessGroupProject({
+    accessGroupIdOrName: "<value>",
+    projectId: "<id>",
+    requestBody: {
+      role: "ADMIN",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    teamId: "<id>",
+    accessGroupId: "<id>",
+    projectId: "<id>",
+    role: "ADMIN",
+    createdAt: "<value>",
+    updatedAt: "<value>",
+  });
+});
+
+test("Access Groups Update Access Group Project Id", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("updateAccessGroupProject-id"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.updateAccessGroupProject({
+    accessGroupIdOrName: "ag_1a2b3c4d5e6f7g8h9i0j",
+    projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+    requestBody: {
+      role: "ADMIN",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    teamId: "<id>",
+    accessGroupId: "<id>",
+    projectId: "<id>",
+    role: "ADMIN",
+    createdAt: "1706645964469",
+    updatedAt: "1735872085577",
+  });
+});
+
+test("Access Groups Update Access Group Project Name", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("updateAccessGroupProject-name"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.accessGroups.updateAccessGroupProject({
+    accessGroupIdOrName: "My Access Group",
+    projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+    requestBody: {
+      role: "ADMIN",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    teamId: "<id>",
+    accessGroupId: "<id>",
+    projectId: "<id>",
+    role: "ADMIN",
+    createdAt: "1708158031858",
+    updatedAt: "1735838146635",
+  });
+});
+
+test("Access Groups Delete Access Group Project Id", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("deleteAccessGroupProject-id"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  await vercel.accessGroups.deleteAccessGroupProject({
+    accessGroupIdOrName: "ag_1a2b3c4d5e6f7g8h9i0j",
+    projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+});
+
+test("Access Groups Delete Access Group Project Name", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("deleteAccessGroupProject-name"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  await vercel.accessGroups.deleteAccessGroupProject({
+    accessGroupIdOrName: "My Access Group",
+    projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+});
+
+test("Access Groups Delete Access Group Project", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("deleteAccessGroupProject"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  await vercel.accessGroups.deleteAccessGroupProject({
+    accessGroupIdOrName: "<value>",
+    projectId: "<id>",
+  });
+});

package/src/__tests__/aliases.test.ts

@@ -0,0 +1,136 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { Vercel } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Aliases List Aliases", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("listAliases"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.aliases.listAliases({
+    domain: "my-test-domain.com",
+    from: 1540095775951,
+    limit: 10,
+    projectId: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
+    since: 1540095775941,
+    until: 1540095775951,
+    rollbackDeploymentId: "dpl_XXX",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    aliases: [],
+    pagination: {
+      count: 20,
+      next: 1540095775951,
+      prev: 1540095775951,
+    },
+  });
+});
+
+test("Aliases Get Alias", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("getAlias"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.aliases.getAlias({
+    from: 1540095775951,
+    idOrAlias: "example.vercel.app",
+    projectId: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
+    since: 1540095775941,
+    until: 1540095775951,
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    alias: "my-alias.vercel.app",
+    created: new Date("2017-04-26T23:00:34.232Z"),
+    createdAt: 1540095775941,
+    creator: {
+      uid: "96SnxkFiMyVKsK3pnoHfx3Hz",
+      email: "john-doe@gmail.com",
+      username: "john-doe",
+    },
+    deletedAt: 1540095775941,
+    deployment: {
+      id: "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
+      url: "my-instant-deployment-3ij3cxz9qr.now.sh",
+      meta: "{}",
+    },
+    deploymentId: "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
+    projectId: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
+    uid: "<id>",
+    updatedAt: 1540095775941,
+  });
+});
+
+test("Aliases Delete Alias", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("deleteAlias"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.aliases.deleteAlias({
+    aliasId: "<id>",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    status: "SUCCESS",
+  });
+});
+
+test("Aliases List Deployment Aliases", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("listDeploymentAliases"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.aliases.listDeploymentAliases({
+    id: "dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    aliases: [],
+  });
+});
+
+test("Aliases Assign Alias", async () => {
+  const vercel = new Vercel({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: createTestHTTPClient("assignAlias"),
+    bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const result = await vercel.aliases.assignAlias({
+    id: "<id>",
+    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
+    slug: "my-team-url-slug",
+    requestBody: {
+      alias: "my-alias.vercel.app",
+      redirect: null,
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    uid: "2WjyKQmM8ZnGcJsPWMrHRHrE",
+    alias: "my-alias.vercel.app",
+    created: new Date("2017-04-26T23:00:34.232Z"),
+    oldDeploymentId: "dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa",
+  });
+});