@greensecurity/javascript-sdk 0.46.0-beta.8 → 0.46.0-beta.9

package/src/__tests__/apps.test.ts

@@ -0,0 +1,782 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { GreenSecurity } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Apps List App Activations", async () => {
+  const testHttpClient = createTestHTTPClient("listAppActivations");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.listAppActivations({
+    desc: true,
+  });
+  expect(result).toBeDefined();
+  expect(result!.result).toBeDefined();
+  expect(result!.result).toEqual({
+    pager: {
+      baseUrl: "api/vendors/job_titles",
+      sort: "job,title",
+      desc: 0,
+      itemCount: 228,
+      itemsPerPage: 306966,
+      page: 1,
+      useUrlParams: true,
+      scope: null,
+    },
+    items: [],
+  });
+});
+
+test("Apps Rotate App Webhook Endpoint Secret", async () => {
+  const testHttpClient = createTestHTTPClient("rotateAppWebhookEndpointSecret");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.rotateAppWebhookEndpointSecret({
+    marketplaceAppId: 54561,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    marketplaceAppId: 42,
+    url: "https://hooks.example.com/green-security",
+    events: [
+      "MarketplaceAppActivation.created",
+    ],
+    secret: "<value>",
+    secretRotatedAt: new Date("2025-10-02T13:10:36.117Z"),
+    previousSecretExpiresAt: new Date("2025-11-12T16:02:44.334Z"),
+  });
+});
+
+test("Apps List App Secrets", async () => {
+  const testHttpClient = createTestHTTPClient("listAppSecrets");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.listAppSecrets({
+    scope: {
+      type: "user",
+    },
+    desc: true,
+  });
+  expect(result).toBeDefined();
+  expect(result!.result).toBeDefined();
+  expect(result!.result).toEqual({
+    pager: {
+      baseUrl: "api/vendors/job_titles",
+      sort: "job,title",
+      desc: 0,
+      itemCount: 228,
+      itemsPerPage: 342295,
+      page: 1,
+      useUrlParams: true,
+      scope: null,
+    },
+    items: [],
+  });
+});
+
+test("Apps Set App Secret", async () => {
+  const testHttpClient = createTestHTTPClient("setAppSecret");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.setAppSecret({
+    name: "acme_api_key",
+    payload: "<value>",
+    scope: {
+      type: "user",
+    },
+    expiresAt: 1790035200,
+    activationId: 1087,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    id: 311,
+    object: "app.secret",
+    name: "acme_api_key",
+    scope: {
+      type: "user",
+    },
+    created: 1758499200,
+    expiresAt: 1790035200,
+  });
+});
+
+test("Apps Find App Secret", async () => {
+  const testHttpClient = createTestHTTPClient("findAppSecret");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.findAppSecret({
+    name: "acme_api_key",
+    scope: {
+      type: "user",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    id: 311,
+    object: "app.secret",
+    name: "acme_api_key",
+    scope: {
+      type: "installation",
+    },
+    created: 1758499200,
+    expiresAt: 1790035200,
+  });
+});
+
+test("Apps Delete App Secret", async () => {
+  const testHttpClient = createTestHTTPClient("deleteAppSecret");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.deleteAppSecret({
+    name: "acme_api_key",
+    scope: {
+      type: "user",
+    },
+    activationId: 1087,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    id: 311,
+    object: "app.secret",
+    name: "acme_api_key",
+    scope: {
+      type: "installation",
+    },
+    created: 1758499200,
+    expiresAt: 1790035200,
+    deleted: true,
+  });
+});
+
+test("Apps Publish App Manifest Ui App", async () => {
+  const testHttpClient = createTestHTTPClient("publishAppManifest-uiApp");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.publishAppManifest({
+    id: 42,
+    name: "Acme Rep Insights",
+    icon: "https://cdn.acme.com/gs-app/icon.png",
+    shortDescription: "Rep activity insights inside Green Security.",
+    version: "1.3.0",
+    permissions: [
+      {
+        permission: "vendors.view",
+        purpose: "Show each rep's activity next to their vendor record.",
+        justification:
+          "The panel exists to show the vendor on screen; without it the app has nothing to show.",
+      },
+    ],
+    configurationInstructions:
+      "Install the app, then open Acme Rep Insights from the vendor list.",
+    supportInstructions: "Email support@acme.com.",
+    uiExtensions: {
+      bundle: {
+        url: "https://cdn.acme.com/gs-app/1.3.0/app.js",
+        integrity:
+          "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC",
+      },
+      views: [
+        {
+          viewport: "gs.company.vendor.detail",
+          component: "VendorPanel",
+        },
+      ],
+    },
+    postInstallAction: {
+      type: "app_main_view",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    success: true,
+    published: {
+      id: 42,
+      name: "Acme Rep Insights",
+      icon: "<value>",
+      shortDescription: "<value>",
+      version: "1.3.0",
+      permissions: [
+        {
+          permission: "vendors.view",
+          purpose: "<value>",
+        },
+      ],
+      configurationInstructions: "<value>",
+      supportInstructions: "<value>",
+      uiExtensions: {
+        bundle: {
+          url: "https://cdn.acme.com/gs-app/1.3.0/app.js",
+          integrity:
+            "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC",
+        },
+        views: [
+          {
+            viewport: "gs.system.visitor.list.row_action",
+            component: "VendorPanel",
+          },
+        ],
+        csp: {
+          connectSrc: [
+            "https://api.acme.com/gs/",
+          ],
+          imageSrc: [
+            "https://api.acme.com/gs/",
+          ],
+          purpose: "<value>",
+        },
+      },
+      webhooks: {
+        url: "https://sync.acme.com/green-security/webhooks",
+      },
+    },
+    version: "1.3.0",
+    status: "rejected",
+    reviewReasons: [
+      {
+        code: "csp_denylisted",
+        message:
+          "abc.trycloudflare.com is a tunnelling service, which apps may not reach",
+        path: "ui_extensions.csp.connect_src",
+      },
+    ],
+  });
+});
+
+test("Apps Publish App Manifest Back End Only", async () => {
+  const testHttpClient = createTestHTTPClient("publishAppManifest-backEndOnly");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.publishAppManifest({
+    id: 43,
+    name: "Acme Credential Sync",
+    icon: "https://cdn.acme.com/sync/icon.png",
+    shortDescription: "Keeps vendor credentials in sync with Acme HR.",
+    version: "1.0.0",
+    permissions: [
+      {
+        permission: "vendor_credentials.view",
+        purpose: "Read credentials to compare them with Acme HR records.",
+        justification:
+          "Comparing credential status with Acme HR is the app's only job, so it can't run without reading credentials.",
+      },
+      {
+        permission: "app_secrets.write",
+        purpose:
+          "Remember which Acme HR workspace each installation syncs with.",
+        justification:
+          "The sync runs for each installation separately and has to keep that installation's workspace choice between runs.",
+      },
+    ],
+    configurationInstructions:
+      "Install the app, then finish setup on the Acme page it opens.",
+    supportInstructions: "Email support@acme.com.",
+    postInstallAction: {
+      type: "url",
+      url: "https://sync.acme.com/green-security/setup",
+    },
+    webhooks: {
+      url: "https://sync.acme.com/green-security/webhooks",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    success: true,
+    published: {
+      id: 42,
+      name: "Acme Rep Insights",
+      icon: "<value>",
+      shortDescription: "<value>",
+      version: "1.3.0",
+      permissions: [
+        {
+          permission: "vendors.view",
+          purpose: "<value>",
+        },
+      ],
+      configurationInstructions: "<value>",
+      supportInstructions: "<value>",
+      uiExtensions: {
+        bundle: {
+          url: "https://cdn.acme.com/gs-app/1.3.0/app.js",
+          integrity:
+            "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC",
+        },
+        views: [
+          {
+            viewport: "gs.system.visitor.list.row_action",
+            component: "VendorPanel",
+          },
+        ],
+        csp: {
+          connectSrc: [
+            "https://api.acme.com/gs/",
+          ],
+          imageSrc: [
+            "https://api.acme.com/gs/",
+          ],
+          purpose: "<value>",
+        },
+      },
+      webhooks: {
+        url: "https://sync.acme.com/green-security/webhooks",
+      },
+    },
+    version: "1.3.0",
+    status: "rejected",
+    reviewReasons: [
+      {
+        code: "csp_denylisted",
+        message:
+          "abc.trycloudflare.com is a tunnelling service, which apps may not reach",
+        path: "ui_extensions.csp.connect_src",
+      },
+    ],
+  });
+});
+
+test("Apps Publish App Manifest", async () => {
+  const testHttpClient = createTestHTTPClient("publishAppManifest");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.publishAppManifest({
+    id: 42,
+    name: "Acme Rep Insights",
+    icon: "<value>",
+    shortDescription: "<value>",
+    version: "1.3.0",
+    permissions: [
+      {
+        permission: "vendors.view",
+        purpose: "<value>",
+      },
+    ],
+    configurationInstructions: "<value>",
+    supportInstructions: "<value>",
+    uiExtensions: {
+      bundle: {
+        url: "https://cdn.acme.com/gs-app/1.3.0/app.js",
+        integrity:
+          "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC",
+      },
+      views: [
+        {
+          viewport: "gs.system.visitor.list.row_action",
+          component: "VendorPanel",
+        },
+      ],
+      csp: {
+        connectSrc: [
+          "https://api.acme.com/gs/",
+        ],
+        imageSrc: [
+          "https://api.acme.com/gs/",
+        ],
+        purpose: "<value>",
+      },
+    },
+    webhooks: {
+      url: "https://sync.acme.com/green-security/webhooks",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    success: true,
+    published: {
+      id: 42,
+      name: "Acme Rep Insights",
+      icon: "<value>",
+      shortDescription: "<value>",
+      version: "1.3.0",
+      permissions: [
+        {
+          permission: "vendors.view",
+          purpose: "<value>",
+        },
+      ],
+      configurationInstructions: "<value>",
+      supportInstructions: "<value>",
+      uiExtensions: {
+        bundle: {
+          url: "https://cdn.acme.com/gs-app/1.3.0/app.js",
+          integrity:
+            "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC",
+        },
+        views: [
+          {
+            viewport: "gs.system.visitor.list.row_action",
+            component: "VendorPanel",
+          },
+        ],
+        csp: {
+          connectSrc: [
+            "https://api.acme.com/gs/",
+          ],
+          imageSrc: [
+            "https://api.acme.com/gs/",
+          ],
+          purpose: "<value>",
+        },
+      },
+      webhooks: {
+        url: "https://sync.acme.com/green-security/webhooks",
+      },
+    },
+    version: "1.3.0",
+    status: "rejected",
+    reviewReasons: [
+      {
+        code: "csp_denylisted",
+        message:
+          "abc.trycloudflare.com is a tunnelling service, which apps may not reach",
+        path: "ui_extensions.csp.connect_src",
+      },
+    ],
+  });
+});
+
+test("Apps List App Developers", async () => {
+  const testHttpClient = createTestHTTPClient("listAppDevelopers");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.listAppDevelopers({
+    id: 789098,
+  });
+  expect(result).toBeDefined();
+  expect(result!.result).toBeDefined();
+  expect(result!.result).toEqual({
+    pager: {
+      baseUrl: "api/vendors/job_titles",
+      sort: "job,title",
+      desc: 0,
+      itemCount: 228,
+      itemsPerPage: 217767,
+      page: 1,
+      useUrlParams: true,
+      scope: null,
+    },
+    items: [
+      {
+        id: 17,
+        appId: 42,
+        userId: 5123,
+        name: "Dana Developer",
+        email: "dana@acme.com",
+        role: "owner",
+      },
+    ],
+  });
+});
+
+test("Apps Add App Developer", async () => {
+  const testHttpClient = createTestHTTPClient("addAppDeveloper");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.addAppDeveloper({
+    id: 239651,
+    appDeveloperAdd: {
+      email: "dana@acme.com",
+      role: "developer",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    id: 17,
+    appId: 42,
+    userId: 5123,
+    name: "Dana Developer",
+    email: "dana@acme.com",
+    role: "developer",
+  });
+});
+
+test("Apps Remove App Developer", async () => {
+  const testHttpClient = createTestHTTPClient("removeAppDeveloper");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.removeAppDeveloper({
+    id: 261180,
+    userId: 902361,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    success: true,
+  });
+});
+
+test("Apps List App Versions", async () => {
+  const testHttpClient = createTestHTTPClient("listAppVersions");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.listAppVersions({
+    appId: 70069,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    "key": {
+      status: "accepted",
+      systems: 1,
+      facilities: 3,
+      companies: 12,
+      users: 40,
+    },
+  });
+});
+
+test("Apps Create App Dev Session", async () => {
+  const testHttpClient = createTestHTTPClient("createAppDevSession");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.createAppDevSession({
+    appId: 646547,
+    devSessionCreate: {
+      manifest: {
+        id: 42,
+        name: "<value>",
+        icon: "<value>",
+        shortDescription: "<value>",
+        permissions: [
+          {
+            permission: "vendors.view",
+            purpose: "<value>",
+          },
+        ],
+        configurationInstructions: "<value>",
+        supportInstructions: "<value>",
+        uiExtensions: {
+          bundle: {
+            url: "https://cdn.acme.com/gs-app/1.3.0/app.js",
+            integrity:
+              "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC",
+          },
+          views: [
+            {
+              viewport: "settings",
+              component: "VendorPanel",
+            },
+          ],
+          csp: {
+            connectSrc: [
+              "https://api.acme.com/gs/",
+            ],
+            imageSrc: [
+              "https://api.acme.com/gs/",
+            ],
+            purpose: "<value>",
+          },
+        },
+        webhooks: {
+          url: "https://sync.acme.com/green-security/webhooks",
+        },
+      },
+      origin: "http://localhost:4300",
+      serverToken: "<value>",
+      publicKeyJwk: {
+        kty: "EC",
+        crv: "P-256",
+        x: "<value>",
+        y: "<value>",
+        use: "sig",
+      },
+      activationId: 1087,
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    id: "q2V7mX9kT4bLc8Rn0pWz3yHa5dEf1gJk",
+    appId: 42,
+    activationId: 1087,
+    developerUserId: 5123,
+    expiresAt: 1758542400000,
+    origin: "http://localhost:4300",
+    publicKeyJwk: {
+      kty: "EC",
+      crv: "P-256",
+      x: "<value>",
+      y: "<value>",
+      use: "sig",
+    },
+    manifest: {
+      id: 42,
+      name: "<value>",
+      icon: "<value>",
+      shortDescription: "<value>",
+      permissions: [
+        {
+          permission: "vendors.view",
+          purpose: "<value>",
+        },
+      ],
+      configurationInstructions: "<value>",
+      supportInstructions: "<value>",
+      uiExtensions: {
+        bundle: {
+          url: "https://cdn.acme.com/gs-app/1.3.0/app.js",
+          integrity:
+            "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC",
+        },
+        views: [
+          {
+            viewport: "settings",
+            component: "VendorPanel",
+          },
+        ],
+        csp: {
+          connectSrc: [
+            "https://api.acme.com/gs/",
+          ],
+          imageSrc: [
+            "https://api.acme.com/gs/",
+          ],
+          purpose: "<value>",
+        },
+      },
+      webhooks: {
+        url: "https://sync.acme.com/green-security/webhooks",
+      },
+    },
+  });
+});
+
+test("Apps Close App Dev Session", async () => {
+  const testHttpClient = createTestHTTPClient("closeAppDevSession");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.closeAppDevSession({
+    appId: 533603,
+    id: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    success: true,
+  });
+});
+
+test("Apps Heartbeat App Dev Session", async () => {
+  const testHttpClient = createTestHTTPClient("heartbeatAppDevSession");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.apps.heartbeatAppDevSession({
+    appId: 634910,
+    id: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    id: "<id>",
+    expiresAt: 130909,
+  });
+});