@greensecurity/javascript-sdk 0.30.44 → 0.30.46

package/REACT_QUERY.md

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

package/README.md

@@ -309,7 +309,7 @@ run();
 
 * [getCurrentUser](docs/sdks/users/README.md#getcurrentuser) - Get current user
 * [getUserById](docs/sdks/users/README.md#getuserbyid) - Get user by id
-* [logsUserIntoTheSystem](docs/sdks/users/README.md#logsuserintothesystem) - Logs user into the system
+* [postAuthenticate](docs/sdks/users/README.md#postauthenticate) - Logs user into the system
 * [magiclink](docs/sdks/users/README.md#magiclink) - Magic link
 * [passwordResetRequest](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
 * [password](docs/sdks/users/README.md#password) - Password reset
@@ -320,6 +320,7 @@ run();
 * [createVendorRegistration](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
 * [listVendorJobTitles](docs/sdks/vendors/README.md#listvendorjobtitles) - List vendor job titles
 * [listVendorCredentials](docs/sdks/vendors/README.md#listvendorcredentials) - List Vendor Credentials
+* [getVendorCredentialDetails](docs/sdks/vendors/README.md#getvendorcredentialdetails) - Get Vendor Credential details
 * [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
@@ -347,6 +348,7 @@ run();
 
 * [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.
+* [updatesTheWebhookEndpointWithTheGivenId](docs/sdks/webhooks/README.md#updatesthewebhookendpointwiththegivenid) - Updates the webhook endpoint with the given ID.
 
 ### [zones](docs/sdks/zones/README.md)
 
@@ -379,16 +381,17 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`usersChangePassword`](docs/sdks/users/README.md#changepassword) - Change password
 - [`usersGetCurrentUser`](docs/sdks/users/README.md#getcurrentuser) - Get current user
 - [`usersGetUserById`](docs/sdks/users/README.md#getuserbyid) - Get user by id
-- [`usersLogsUserIntoTheSystem`](docs/sdks/users/README.md#logsuserintothesystem) - Logs user into the system
 - [`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
+- [`usersPostAuthenticate`](docs/sdks/users/README.md#postauthenticate) - Logs user into the system
 - [`vendorsAddVendorManagedByCompany`](docs/sdks/vendors/README.md#addvendormanagedbycompany) - Add vendor managed by company
 - [`vendorScansVendorScanOut`](docs/sdks/vendorscans/README.md#vendorscanout) - Vendor scan out
 - [`vendorsCreateVendorCompany`](docs/sdks/vendors/README.md#createvendorcompany) - Create vendor company
 - [`vendorsCreateVendorRegistration`](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
 - [`vendorsDeleteVendorManagedByCompany`](docs/sdks/vendors/README.md#deletevendormanagedbycompany) - Delete vendor managed by company
 - [`vendorsExpediteTimeRemaining`](docs/sdks/vendors/README.md#expeditetimeremaining) - Expedite time remaining
+- [`vendorsGetVendorCredentialDetails`](docs/sdks/vendors/README.md#getvendorcredentialdetails) - Get Vendor Credential details
 - [`vendorsGetVendorInvoiceDetails`](docs/sdks/vendors/README.md#getvendorinvoicedetails) - Get vendor invoice details
 - [`vendorsGetVendorsDetails`](docs/sdks/vendors/README.md#getvendorsdetails) - Get vendors details
 - [`vendorsListVendorAdditionalFacilityFields`](docs/sdks/vendors/README.md#listvendoradditionalfacilityfields) - List of vendor's additional facility fields
@@ -407,6 +410,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`vendorsUpdateVendorScrubDetails`](docs/sdks/vendors/README.md#updatevendorscrubdetails) - Update vendor scrub details
 - [`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 
+- [`webhooksUpdatesTheWebhookEndpointWithTheGivenId`](docs/sdks/webhooks/README.md#updatesthewebhookendpointwiththegivenid) - Updates the webhook endpoint with the given ID.
 - [`zonesListOrSearchSecurityZones`](docs/sdks/zones/README.md#listorsearchsecurityzones) - List or search security zones
 - [`zonesSecurityZoneCheckin`](docs/sdks/zones/README.md#securityzonecheckin) - Security zone checkin request
 
@@ -443,16 +447,17 @@ To learn about this feature and how to get started, check
 - [`useUsersChangePasswordMutation`](docs/sdks/users/README.md#changepassword) - Change password
 - [`useUsersGetCurrentUser`](docs/sdks/users/README.md#getcurrentuser) - Get current user
 - [`useUsersGetUserById`](docs/sdks/users/README.md#getuserbyid) - Get user by id
-- [`useUsersLogsUserIntoTheSystemMutation`](docs/sdks/users/README.md#logsuserintothesystem) - Logs user into the system
 - [`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
+- [`useUsersPostAuthenticateMutation`](docs/sdks/users/README.md#postauthenticate) - Logs user into the system
 - [`useVendorsAddVendorManagedByCompanyMutation`](docs/sdks/vendors/README.md#addvendormanagedbycompany) - Add vendor managed by company
 - [`useVendorScansVendorScanOutMutation`](docs/sdks/vendorscans/README.md#vendorscanout) - Vendor scan out
 - [`useVendorsCreateVendorCompanyMutation`](docs/sdks/vendors/README.md#createvendorcompany) - Create vendor company
 - [`useVendorsCreateVendorRegistrationMutation`](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
 - [`useVendorsDeleteVendorManagedByCompanyMutation`](docs/sdks/vendors/README.md#deletevendormanagedbycompany) - Delete vendor managed by company
 - [`useVendorsExpediteTimeRemaining`](docs/sdks/vendors/README.md#expeditetimeremaining) - Expedite time remaining
+- [`useVendorsGetVendorCredentialDetails`](docs/sdks/vendors/README.md#getvendorcredentialdetails) - Get Vendor Credential details
 - [`useVendorsGetVendorInvoiceDetails`](docs/sdks/vendors/README.md#getvendorinvoicedetails) - Get vendor invoice details
 - [`useVendorsGetVendorsDetails`](docs/sdks/vendors/README.md#getvendorsdetails) - Get vendors details
 - [`useVendorsListVendorAdditionalFacilityFields`](docs/sdks/vendors/README.md#listvendoradditionalfacilityfields) - List of vendor's additional facility fields
@@ -471,6 +476,7 @@ To learn about this feature and how to get started, check
 - [`useVendorsUpdateVendorScrubDetailsMutation`](docs/sdks/vendors/README.md#updatevendorscrubdetails) - Update vendor scrub details
 - [`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 
+- [`useWebhooksUpdatesTheWebhookEndpointWithTheGivenIdMutation`](docs/sdks/webhooks/README.md#updatesthewebhookendpointwiththegivenid) - Updates the webhook endpoint with the given ID.
 - [`useZonesListOrSearchSecurityZones`](docs/sdks/zones/README.md#listorsearchsecurityzones) - List or search security zones
 - [`useZonesSecurityZoneCheckinMutation`](docs/sdks/zones/README.md#securityzonecheckin) - Security zone checkin request
 
@@ -717,7 +723,7 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { GreenSecurity } from "@greensecurity/javascript-sdk";
 
 const greenSecurity = new GreenSecurity({
-  serverURL: "https://www.greensecurityllc.com/api",
+  serverURL: "https://localhost:3000/api",
 });
 
 async function run() {