@greensecurity/javascript-sdk 0.18.2 → 0.21.1

package/REACT_QUERY.md

@@ -52,11 +52,11 @@ from TanStack Query.
 [use-query]: https://tanstack.com/query/v5/docs/framework/react/reference/useQuery
 
 ```tsx
-import { useVendorsListVendorCredentials } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
+import { useVendorsExpediteTimeRemaining } from "@greensecurity/javascript-sdk/react-query/vendorsExpediteTimeRemaining.js";
 
 export function Example() {
-  const { data, error, status } = useVendorsListVendorCredentials({
-    vendorId: 327408,
+  const { data, error, status } = useVendorsExpediteTimeRemaining({
+    vendorIdOrMe: "<value>",
   });
 
   // Render the UI here...
@@ -70,13 +70,13 @@ more options provided by the query hooks to control these behaviors.
 
 ```tsx
 import { useState } from "react";
-import { useVendorsListVendorCredentials } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
+import { useVendorsExpediteTimeRemaining } from "@greensecurity/javascript-sdk/react-query/vendorsExpediteTimeRemaining.js";
 
 export function ExampleWithOptions() {
   const [enabled, setEnabled] = useState(true);
-  const { data, error, status } = useVendorsListVendorCredentials(
+  const { data, error, status } = useVendorsExpediteTimeRemaining(
     {
-      vendorId: 327408,
+      vendorIdOrMe: "<value>",
     },
     {
       // TanStack Query options:
@@ -184,7 +184,7 @@ query hook there are two functions that help invalidate cached data:
 
 ```tsx
 import { useQueryClient } from "@tanstack/react-query";
-import { invalidateVendorsListVendorCredentials, invalidateAllVendorsListVendorCredentials } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
+import { invalidateVendorsExpediteTimeRemaining, invalidateAllVendorsExpediteTimeRemaining } from "@greensecurity/javascript-sdk/react-query/vendorsExpediteTimeRemaining.js";
 // Replace this with a real mutation
 import { useExampleMutation } from "@greensecurity/javascript-sdk/react-query/example.js";
 
@@ -202,9 +202,9 @@ export function Example() {
         mutate(formData, {
           onSuccess: () => {
             // Invalidate a single cache entry:
-            invalidateVendorsListVendorCredentials(queryClient, /* ... arguments ... */);
+            invalidateVendorsExpediteTimeRemaining(queryClient, /* ... arguments ... */);
             // OR, invalidate all cache entries for the query targets:
-            invalidateAllVendorsListVendorCredentials(queryClient);
+            invalidateAllVendorsExpediteTimeRemaining(queryClient);
           },
         });
       }}
@@ -270,7 +270,7 @@ import { ErrorBoundary } from "react-error-boundary";
 
 import { GreenSecurityCore } from "@greensecurity/javascript-sdk";
 import { GreenSecurityProvider } from "@greensecurity/javascript-sdk/react-query";
-import { useVendorsListVendorCredentialsSuspense } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
+import { useVendorsExpediteTimeRemainingSuspense } from "@greensecurity/javascript-sdk/react-query/vendorsExpediteTimeRemaining.js";
 
 const queryClient = new QueryClient();
 const greenSecurity = new GreenSecurityCore({
@@ -307,8 +307,8 @@ export function App() {
 }
 
 function Example() {
-  const { data } = useVendorsListVendorCredentialsSuspense({
-    vendorId: 327408,
+  const { data } = useVendorsExpediteTimeRemainingSuspense({
+    vendorIdOrMe: "<value>",
   });
 
   // Render the UI here...
@@ -329,7 +329,7 @@ import {
   QueryClient,
 } from "@tanstack/react-query";
 import { GreenSecurityCore } from "@greensecurity/javascript-sdk";
-import { prefetchVendorsListVendorCredentials } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
+import { prefetchVendorsExpediteTimeRemaining } from "@greensecurity/javascript-sdk/react-query/vendorsExpediteTimeRemaining.js";
 
 export default async function Page() {
   const queryClient = new QueryClient();
@@ -339,8 +339,8 @@ export default async function Page() {
     },
   });
 
-  await prefetchVendorsListVendorCredentials(queryClient, greenSecurity, {
-    vendorId: 327408,
+  await prefetchVendorsExpediteTimeRemaining(queryClient, greenSecurity, {
+    vendorIdOrMe: "<value>",
   });
 
   return (

package/README.md

@@ -19,8 +19,8 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
 <!-- Start Summary [summary] -->
 ## Summary
 
-API Reference: The Green Security API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). 
-Our API has predictable resource-oriented URLs, accepts [JSON-encoded](http://www.json.org/) request bodies, 
+API Reference: The Green Security API is organized around [REST](https://en.wikipedia.org/wiki/Representational_State_Transfer). 
+Our API has predictable resource-oriented URLs, accepts [JSON-encoded](https://www.json.org/) request bodies, 
 returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
 
 The API is updated frequently, so be sure to check back often for the latest information.
@@ -99,7 +99,7 @@ yarn add @tanstack/react-query react react-dom
 This SDK is also an installable MCP server where the various SDK methods are
 exposed as tools that can be invoked by AI applications.
 
-> Node.js v20 or greater is required to run the MCP server.
+> Node.js v20 or greater is required to run the MCP server from npm.
 
 <details>
 <summary>Claude installation steps</summary>
@@ -128,17 +128,51 @@ Add the following server definition to your `claude_desktop_config.json` file:
 <details>
 <summary>Cursor installation steps</summary>
 
-Go to `Cursor Settings > Features > MCP Servers > Add new MCP server` and use the following settings:
+Create a `.cursor/mcp.json` file in your project root with the following content:
 
-- Name: GreenSecurity
-- Type: `command`
-- Command:
-```sh
-npx -y --package @greensecurity/javascript-sdk -- mcp start --api-token ... --bearer-jwt ... 
+```json
+{
+  "mcpServers": {
+    "GreenSecurity": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@greensecurity/javascript-sdk",
+        "--",
+        "mcp", "start",
+        "--api-token", "...",
+        "--bearer-jwt", "..."
+      ]
+    }
+  }
+}
 ```
 
 </details>
 
+You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
+
+```bash
+curl -L -o mcp-server \
+    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
+chmod +x mcp-server
+```
+
+If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
+
+
+```json
+{
+  "mcpServers": {
+    "Todos": {
+      "command": "./DOWNLOAD/PATH/mcp-server",
+      "args": [
+        "start"
+      ]
+    }
+  }
+}
+```
+
 For a full list of server arguments, run:
 
 ```sh
@@ -219,6 +253,32 @@ async function run() {
 
 run();
 
+```
+
+### Per-Operation Security Schemes
+
+Some operations in this SDK require the security scheme to be specified at the request level. For example:
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity();
+
+async function run() {
+  const result = await greenSecurity.vendors.listVendorJobTitles({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+    jobLike: "job",
+  }, {});
+
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
+}
+
+run();
+
 ```
 <!-- End Authentication [security] -->
 
@@ -256,6 +316,19 @@ run();
 * [expediteTimeRemaining](docs/sdks/vendors/README.md#expeditetimeremaining) - Expedite time remaining
 * [listVendorInvoices](docs/sdks/vendors/README.md#listvendorinvoices) - List vendor invoices
 * [getVendorInvoiceDetails](docs/sdks/vendors/README.md#getvendorinvoicedetails) - Get vendor invoice details
+* [listVendorFacilityStatuses](docs/sdks/vendors/README.md#listvendorfacilitystatuses) - List vendor facility statuses
+* [listVendorScrubPurchases](docs/sdks/vendors/README.md#listvendorscrubpurchases) - List vendor scrub purchases
+* [listVendorScrubDetails](docs/sdks/vendors/README.md#listvendorscrubdetails) - List vendor scrub details
+* [getVendorsDetails](docs/sdks/vendors/README.md#getvendorsdetails) - Get vendors details
+
+### [vendorScans](docs/sdks/vendorscans/README.md)
+
+* [vendorScanOut](docs/sdks/vendorscans/README.md#vendorscanout) - Vendor scan out
+
+### [webhooks](docs/sdks/webhooks/README.md)
+
+* [listAllWebhookEndpoints](docs/sdks/webhooks/README.md#listallwebhookendpoints) - List all webhook endpoints 
+* [getWebhookEndpoint](docs/sdks/webhooks/README.md#getwebhookendpoint) - Retrieves the webhook endpoint with the given ID.
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -285,12 +358,19 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`usersMagiclink`](docs/sdks/users/README.md#magiclink) - Magic link
 - [`usersPassword`](docs/sdks/users/README.md#password) - Password reset
 - [`usersPasswordResetRequest`](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
+- [`vendorScansVendorScanOut`](docs/sdks/vendorscans/README.md#vendorscanout) - Vendor scan out
 - [`vendorsCreateVendorRegistration`](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
 - [`vendorsExpediteTimeRemaining`](docs/sdks/vendors/README.md#expeditetimeremaining) - Expedite time remaining
 - [`vendorsGetVendorInvoiceDetails`](docs/sdks/vendors/README.md#getvendorinvoicedetails) - Get vendor invoice details
+- [`vendorsGetVendorsDetails`](docs/sdks/vendors/README.md#getvendorsdetails) - Get vendors details
 - [`vendorsListVendorCredentials`](docs/sdks/vendors/README.md#listvendorcredentials) - List Vendor Credentials
+- [`vendorsListVendorFacilityStatuses`](docs/sdks/vendors/README.md#listvendorfacilitystatuses) - List vendor facility statuses
 - [`vendorsListVendorInvoices`](docs/sdks/vendors/README.md#listvendorinvoices) - List vendor invoices
 - [`vendorsListVendorJobTitles`](docs/sdks/vendors/README.md#listvendorjobtitles) - List vendor job titles
+- [`vendorsListVendorScrubDetails`](docs/sdks/vendors/README.md#listvendorscrubdetails) - List vendor scrub details
+- [`vendorsListVendorScrubPurchases`](docs/sdks/vendors/README.md#listvendorscrubpurchases) - List vendor scrub purchases
+- [`webhooksGetWebhookEndpoint`](docs/sdks/webhooks/README.md#getwebhookendpoint) - Retrieves the webhook endpoint with the given ID.
+- [`webhooksListAllWebhookEndpoints`](docs/sdks/webhooks/README.md#listallwebhookendpoints) - List all webhook endpoints 
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -327,12 +407,19 @@ To learn about this feature and how to get started, check
 - [`useUsersMagiclinkMutation`](docs/sdks/users/README.md#magiclink) - Magic link
 - [`useUsersPasswordMutation`](docs/sdks/users/README.md#password) - Password reset
 - [`useUsersPasswordResetRequestMutation`](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
+- [`useVendorScansVendorScanOutMutation`](docs/sdks/vendorscans/README.md#vendorscanout) - Vendor scan out
 - [`useVendorsCreateVendorRegistrationMutation`](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
 - [`useVendorsExpediteTimeRemaining`](docs/sdks/vendors/README.md#expeditetimeremaining) - Expedite time remaining
 - [`useVendorsGetVendorInvoiceDetails`](docs/sdks/vendors/README.md#getvendorinvoicedetails) - Get vendor invoice details
+- [`useVendorsGetVendorsDetails`](docs/sdks/vendors/README.md#getvendorsdetails) - Get vendors details
 - [`useVendorsListVendorCredentials`](docs/sdks/vendors/README.md#listvendorcredentials) - List Vendor Credentials
+- [`useVendorsListVendorFacilityStatuses`](docs/sdks/vendors/README.md#listvendorfacilitystatuses) - List vendor facility statuses
 - [`useVendorsListVendorInvoices`](docs/sdks/vendors/README.md#listvendorinvoices) - List vendor invoices
 - [`useVendorsListVendorJobTitles`](docs/sdks/vendors/README.md#listvendorjobtitles) - List vendor job titles
+- [`useVendorsListVendorScrubDetails`](docs/sdks/vendors/README.md#listvendorscrubdetails) - List vendor scrub details
+- [`useVendorsListVendorScrubPurchases`](docs/sdks/vendors/README.md#listvendorscrubpurchases) - List vendor scrub purchases
+- [`useWebhooksGetWebhookEndpoint`](docs/sdks/webhooks/README.md#getwebhookendpoint) - Retrieves the webhook endpoint with the given ID.
+- [`useWebhooksListAllWebhookEndpoints`](docs/sdks/webhooks/README.md#listallwebhookendpoints) - List all webhook endpoints 
 
 </details>
 <!-- End React hooks with TanStack Query [react-query] -->