@greensecurity/javascript-sdk 0.45.0-beta.2 → 0.45.0-beta.20

package/src/react-query/vendorsGetVendorScreeningQuestions.ts

@@ -0,0 +1,152 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildVendorsGetVendorScreeningQuestionsQuery,
+  prefetchVendorsGetVendorScreeningQuestions,
+  queryKeyVendorsGetVendorScreeningQuestions,
+  VendorsGetVendorScreeningQuestionsQueryData,
+} from "./vendorsGetVendorScreeningQuestions.core.js";
+export {
+  buildVendorsGetVendorScreeningQuestionsQuery,
+  prefetchVendorsGetVendorScreeningQuestions,
+  queryKeyVendorsGetVendorScreeningQuestions,
+  type VendorsGetVendorScreeningQuestionsQueryData,
+};
+
+export type VendorsGetVendorScreeningQuestionsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List a vendor's target-facility screening questions and answers
+ *
+ * @remarks
+ * Returns every active target-facility screening question that currently applies to the vendor at the given facility, each paired with the vendor's answer when one has been given. Questions that have not been answered are included with a null answer. Read-only; used to review a rep's screening answers.
+ */
+export function useVendorsGetVendorScreeningQuestions(
+  request: operations.GetVendorScreeningQuestionsRequest,
+  options?: QueryHookOptions<
+    VendorsGetVendorScreeningQuestionsQueryData,
+    VendorsGetVendorScreeningQuestionsQueryError
+  >,
+): UseQueryResult<
+  VendorsGetVendorScreeningQuestionsQueryData,
+  VendorsGetVendorScreeningQuestionsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsGetVendorScreeningQuestionsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List a vendor's target-facility screening questions and answers
+ *
+ * @remarks
+ * Returns every active target-facility screening question that currently applies to the vendor at the given facility, each paired with the vendor's answer when one has been given. Questions that have not been answered are included with a null answer. Read-only; used to review a rep's screening answers.
+ */
+export function useVendorsGetVendorScreeningQuestionsSuspense(
+  request: operations.GetVendorScreeningQuestionsRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsGetVendorScreeningQuestionsQueryData,
+    VendorsGetVendorScreeningQuestionsQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorsGetVendorScreeningQuestionsQueryData,
+  VendorsGetVendorScreeningQuestionsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsGetVendorScreeningQuestionsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorsGetVendorScreeningQuestionsData(
+  client: QueryClient,
+  queryKeyBase: [vendorIdOrMe: string, parameters: { facilityId: number }],
+  data: VendorsGetVendorScreeningQuestionsQueryData,
+): VendorsGetVendorScreeningQuestionsQueryData | undefined {
+  const key = queryKeyVendorsGetVendorScreeningQuestions(...queryKeyBase);
+
+  return client.setQueryData<VendorsGetVendorScreeningQuestionsQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorsGetVendorScreeningQuestions(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [vendorIdOrMe: string, parameters: { facilityId: number }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorScreeningQuestions",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsGetVendorScreeningQuestions(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorScreeningQuestions",
+    ],
+  });
+}

package/src/react-query/vendorsUpdateVendorDetails.ts

@@ -56,7 +56,15 @@ export type VendorsUpdateVendorDetailsMutationError =
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
  * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
  * `country` properties of the shared `UserLocation` schema are ignored here and
- * updating them is not supported.
+ * updating them is not supported. `state` accepts a US state or a Canadian
+ * province — the vendor's country, set only at registration, is not editable
+ * through this endpoint.
+ *
+ * Submitting `location.zip` or `location.state` cross-checks the postal code
+ * against the resulting state (using the vendor's existing value for whichever
+ * of the two is left out of the request). A code that is not shaped like a real
+ * postal code, or that provably belongs to a different state, is rejected with
+ * `422` naming the correct state.
  *
  * For `title`, the `supervisor` fields, and every `location` field except
  * `timezone`, the value sent is the value stored: omit a field to leave it

package/src/react-query/vendorsVendorsExport.core.ts

@@ -57,6 +57,7 @@ export function buildVendorsVendorsExportQuery(
       zipLike: request.zipLike,
       status: request.status,
       companyId: request.companyId,
+      externallyManagedByCompanyId: request.externallyManagedByCompanyId,
       credentialingSubscriptionIdNull: request.credentialingSubscriptionIdNull,
       scrubsSubscriptionIdNull: request.scrubsSubscriptionIdNull,
       credentialingSubscriptionStatus: request.credentialingSubscriptionStatus,
@@ -110,6 +111,7 @@ export function queryKeyVendorsVendorsExport(
     zipLike?: string | undefined;
     status?: string | undefined;
     companyId?: number | undefined;
+    externallyManagedByCompanyId?: number | undefined;
     credentialingSubscriptionIdNull?: string | undefined;
     scrubsSubscriptionIdNull?: string | undefined;
     credentialingSubscriptionStatus?: string | undefined;

package/src/react-query/vendorsVendorsExport.ts

@@ -58,7 +58,10 @@ export type VendorsVendorsExportQueryError =
  *
  * @remarks
  * Enqueues an asynchronous job to generate a CSV export of vendors based on the
- * provided filters (the same filters supported by the vendors list endpoint).
+ * provided filters (the same filters supported by the vendors list endpoint), in the same
+ * credential-inclusive format as the portal's "Download Full Report" button - one column per
+ * applicable credential (status, due date, expiration), plus counts and percentage approved,
+ * alongside the vendor's identity, contact, and company details.
  * Returns a `status_url` to poll until the export is ready, plus a
  * `download_url` and `status_id`.
  */
@@ -88,7 +91,10 @@ export function useVendorsVendorsExport(
  *
  * @remarks
  * Enqueues an asynchronous job to generate a CSV export of vendors based on the
- * provided filters (the same filters supported by the vendors list endpoint).
+ * provided filters (the same filters supported by the vendors list endpoint), in the same
+ * credential-inclusive format as the portal's "Download Full Report" button - one column per
+ * applicable credential (status, due date, expiration), plus counts and percentage approved,
+ * alongside the vendor's identity, contact, and company details.
  * Returns a `status_url` to poll until the export is ready, plus a
  * `download_url` and `status_id`.
  */
@@ -130,6 +136,7 @@ export function setVendorsVendorsExportData(
       zipLike?: string | undefined;
       status?: string | undefined;
       companyId?: number | undefined;
+      externallyManagedByCompanyId?: number | undefined;
       credentialingSubscriptionIdNull?: string | undefined;
       scrubsSubscriptionIdNull?: string | undefined;
       credentialingSubscriptionStatus?: string | undefined;
@@ -170,6 +177,7 @@ export function invalidateVendorsVendorsExport(
       zipLike?: string | undefined;
       status?: string | undefined;
       companyId?: number | undefined;
+      externallyManagedByCompanyId?: number | undefined;
       credentialingSubscriptionIdNull?: string | undefined;
       scrubsSubscriptionIdNull?: string | undefined;
       credentialingSubscriptionStatus?: string | undefined;

package/src/sdk/companies.ts

@@ -6,6 +6,7 @@ import { companiesAddCompanyManager } from "../funcs/companiesAddCompanyManager.
 import { companiesGetCompany } from "../funcs/companiesGetCompany.js";
 import { companiesListCompanyCredentials } from "../funcs/companiesListCompanyCredentials.js";
 import { companiesListCompanyCredits } from "../funcs/companiesListCompanyCredits.js";
+import { companiesListCompanyManagerContacts } from "../funcs/companiesListCompanyManagerContacts.js";
 import { companiesListCompanyManagers } from "../funcs/companiesListCompanyManagers.js";
 import { companiesListOrSearchCompanies } from "../funcs/companiesListOrSearchCompanies.js";
 import { companiesLookupCompanies } from "../funcs/companiesLookupCompanies.js";
@@ -152,4 +153,23 @@ export class Companies extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List the contact details of a company's managers
+   *
+   * @remarks
+   * List the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an admin; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{company_id}/managers`, which is the administration listing and is gated on the `company_managers` view permission.
+   */
+  async listCompanyManagerContacts(
+    request: operations.ListCompanyManagerContactsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.ListCompanyManagerContactsListCompanyManagerContactsOk
+  > {
+    return unwrapAsync(companiesListCompanyManagerContacts(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/invoices.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { invoicesConvertQuote } from "../funcs/invoicesConvertQuote.js";
 import { invoicesCreateInvoice } from "../funcs/invoicesCreateInvoice.js";
 import {
   DownloadInvoicesExportAcceptEnum,
@@ -152,6 +153,36 @@ export class Invoices extends ClientSDK {
     ));
   }
 
+  /**
+   * Convert a quote into an invoice
+   *
+   * @remarks
+   * Converts a quote into the real invoice its caller will be charged for, and
+   * returns the new invoice with its calculated totals. Any `VendorCredential`
+   * linked to the quote is re-pointed at the new invoice.
+   *
+   * The operation is idempotent: converting a quote that has already been
+   * processed returns the invoice previously created from it rather than
+   * creating a second one, so a retried request is safe.
+   *
+   * The referenced invoice must actually be a quote — a non-quote invoice id
+   * responds `400`. Requires a caller whose access scope permits creating
+   * invoices; a caller allowed to create the invoice but not to update the
+   * linked `VendorCredential` responds `401`.
+   *
+   * Takes no request body.
+   */
+  async convertQuote(
+    request: operations.ConvertQuoteRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ConvertQuoteConvertQuoteOk> {
+    return unwrapAsync(invoicesConvertQuote(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Export invoices to csv (async)
    *

package/src/sdk/lookups.ts

@@ -3,6 +3,7 @@
  */
 
 import { lookupsListLookupSystems } from "../funcs/lookupsListLookupSystems.js";
+import { lookupsLookupPostalCode } from "../funcs/lookupsLookupPostalCode.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
@@ -31,4 +32,36 @@ export class Lookups extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Check a postal code against a state and country
+   *
+   * @remarks
+   * Cross-checks a postal code against a state/province and country, the same check
+   * every write path that stores a US or Canadian address enforces server-side (e.g.
+   * `PUT /users/{id}`, `PUT /vendors/{vendor_id_or_me}`). Useful for validating an
+   * address before submitting it elsewhere.
+   *
+   * `status` is one of:
+   * - `ok` — the postal code belongs to the given state/province.
+   * - `invalid` — the postal code is not shaped like a real one for the given country.
+   * - `mismatch` — the postal code is well-formed but belongs to a different state or
+   *   province. `expected_states` names the state(s) it actually maps to.
+   * - `unknown` — nothing to check against (an unsupported country, or a postal code
+   *   absent from the US ZIP dataset). Treated as acceptable by every write path that
+   *   uses this check.
+   *
+   * Only the US and Canada have a real code-to-subdivision map; every other country
+   * always returns `unknown`.
+   */
+  async lookupPostalCode(
+    request: operations.LookupPostalCodeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.LookupPostalCodeLookupPostalCodeOk> {
+    return unwrapAsync(lookupsLookupPostalCode(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/reports.ts

@@ -62,9 +62,9 @@ export class Reports extends ClientSDK {
    * | `404` | No such run, or it is outside your access scope. | Stop. |
    * | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
    *
-   * **Bound your polling.** A `409` is not a promise that the run will finish. Report
-   * generation has no terminal failure state today, so a run whose generation crashed part way
-   * through stays in `processing` and keeps answering `409` indefinitely. Apply your own
+   * **Bound your polling.** A `409` is not a promise that the run will finish. A run that fails
+   * while generating is now recorded as `failed` and answers `422`, but a run whose worker died
+   * outright still stays in `processing` and keeps answering `409` indefinitely. Apply your own
    * timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
    *
    * Access control: the URL's `full_report_id` must be in the caller's read scope for

package/src/sdk/sdk.ts

@@ -140,6 +140,9 @@ export class GreenSecurity extends ClientSDK {
     } | Request;
     secret: string;
   }): Promise<
+    | webhooks.SendFullReportCreatedRequest
+    | webhooks.SendFullReportUpdatedRequest
+    | webhooks.SendFullReportDestroyedRequest
     | webhooks.SendVendorCreatedRequest
     | webhooks.SendVendorUpdatedRequest
     | webhooks.SendVendorDestroyedRequest

package/src/sdk/users.ts

@@ -85,6 +85,12 @@ export class Users extends ClientSDK {
    * Only submitted fields are applied — unrecognised fields are silently ignored.
    * Changing `email` automatically resets `bounced_email` to `false`.
    *
+   * Submitting `zip`, `state`, or `country` cross-checks the postal code against the
+   * resulting state/country (using the existing value for any of the three left out
+   * of the request). A code that is not shaped like a real postal code, or that
+   * provably belongs to a different state, is rejected with `422` naming the correct
+   * state.
+   *
    * Each subkey of `email_preferences` is independently optional; sending
    * `{ "email_preferences": { "send_weekly_summary_email": true } }` flips
    * only that flag and leaves the others unchanged.
@@ -142,6 +148,43 @@ export class Users extends ClientSDK {
    * 3. Site redirects to your selected `return_url`
    * 4. The `user_token` will be appended as a query string parameter to your `return_url` - you must parse this token and store it
    * 5. Fetch the user object from `/users/me` using the token
+   *
+   * ## Finishing a "Login with Green Security" flow
+   *
+   * Green Security is also a SAML2 **identity provider**. When a third-party service provider sends a user to
+   * `/saml/idp/sso` to sign in with their Green Security account, the user lands on a Green Security login screen
+   * carrying an `sso_state` query string parameter. That parameter is a signed, five-minute record of which service
+   * provider is waiting, where its assertion consumer service lives, and what `RelayState` it sent.
+   *
+   * Authentication itself is unchanged - the user may still need a password, an MFA code, a magic link or a round trip
+   * to their own SAML IdP, and every `requires` value above applies as normal. The only difference is that you must
+   * echo `sso_state` back on **every** call in the sequence, unchanged, including the follow-up that carries the
+   * `mfa_code`.
+   *
+   * Each `202` response carries the verified blob back to you in its own top-level `sso_state` field. Send back the
+   * value from the response you just received rather than the one you started with. The two are normally the same
+   * string, but re-sending your original copy is how a blob the server has already rejected gets resent, and it forces
+   * you to hold login state you would otherwise not need.
+   *
+   * 1. Read `sso_state` from the query string of the login screen you were sent to
+   * 2. Run the login exactly as you would otherwise, adding `sso_state` to each request body and taking the value for
+   *    the next request from the previous `202` response
+   * 3. On the `200` response, read `sso.continue_url`
+   * 4. Navigate the browser to `sso.continue_url` - a full page navigation, not a background fetch. It answers with a
+   *    self-submitting form that delivers the signed `SAMLResponse` and the original `RelayState` to the service
+   *    provider
+   * 5. The service provider validates the assertion and the user is signed in on their side
+   *
+   * On the `password_reset` leg the blob is **also** appended to `redirect_url` as a query parameter, alongside
+   * `return_url`. The browser follows that redirect and leaves the JSON body behind, so anything the remaining legs of
+   * the login still need has to ride the URL. Preserve the query string exactly as given.
+   *
+   * An invalid `sso_state` never fails a login. A forged, edited or expired blob is silently dropped and the request is
+   * then treated as an ordinary login, so valid credentials still return `200` - just with no `sso` object. Check for
+   * `sso` explicitly rather than reading `200` as proof the hand-off survived. When it is absent, do not retry with the
+   * same blob; the user has to start again from the service provider. See the
+   * [Login with Green Security](https://greensecurity.apidocumentation.com/guides/sso-login-with-green-security)
+   * guide for the service provider half of this flow.
    */
   async postAuthenticate(
     request: operations.PostAuthenticateRequestBody,

package/src/sdk/vendors.ts

@@ -28,6 +28,7 @@ import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoice
 import { vendorsGetVendorInvoiceReceipt } from "../funcs/vendorsGetVendorInvoiceReceipt.js";
 import { vendorsGetVendorLegalName } from "../funcs/vendorsGetVendorLegalName.js";
 import { vendorsGetVendorPaymentResponsibility } from "../funcs/vendorsGetVendorPaymentResponsibility.js";
+import { vendorsGetVendorScreeningQuestions } from "../funcs/vendorsGetVendorScreeningQuestions.js";
 import { vendorsGetVendorsDetails } from "../funcs/vendorsGetVendorsDetails.js";
 import { vendorsGetVendorsExportStatus } from "../funcs/vendorsGetVendorsExportStatus.js";
 import { vendorsGetVendorTargetFacilities } from "../funcs/vendorsGetVendorTargetFacilities.js";
@@ -132,6 +133,10 @@ export class Vendors extends ClientSDK {
    * `company_id` is optional for company managers — it defaults to their own company.
    * All other callers must provide `company_id`. The caller must have access to the
    * specified company (verified via scoped access policy) and the `vendors:add` permission.
+   *
+   * `zip` is cross-checked against `state`: a code that is not shaped like a real postal
+   * code, or that provably belongs to a different state, is rejected with `422` naming
+   * the correct state.
    */
   async createVendor(
     request: operations.CreateVendorRequestBody,
@@ -273,6 +278,7 @@ export class Vendors extends ClientSDK {
    *   - vendor_credential.credential
    *   - vendor_credential.vendor
    *   - vendor_credential.invoice
+   *   - vendor_credential.quote
    *   - vendor_credential.vendor_credential_files
    *   - vendor_credential.latest_vendor_credential_id
    *   - vendor_credential.previously_approved
@@ -879,7 +885,15 @@ export class Vendors extends ClientSDK {
    * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
    * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
    * `country` properties of the shared `UserLocation` schema are ignored here and
-   * updating them is not supported.
+   * updating them is not supported. `state` accepts a US state or a Canadian
+   * province — the vendor's country, set only at registration, is not editable
+   * through this endpoint.
+   *
+   * Submitting `location.zip` or `location.state` cross-checks the postal code
+   * against the resulting state (using the vendor's existing value for whichever
+   * of the two is left out of the request). A code that is not shaped like a real
+   * postal code, or that provably belongs to a different state, is rejected with
+   * `422` naming the correct state.
    *
    * For `title`, the `supervisor` fields, and every `location` field except
    * `timezone`, the value sent is the value stored: omit a field to leave it
@@ -1078,7 +1092,10 @@ export class Vendors extends ClientSDK {
    *
    * @remarks
    * Enqueues an asynchronous job to generate a CSV export of vendors based on the
-   * provided filters (the same filters supported by the vendors list endpoint).
+   * provided filters (the same filters supported by the vendors list endpoint), in the same
+   * credential-inclusive format as the portal's "Download Full Report" button - one column per
+   * applicable credential (status, due date, expiration), plus counts and percentage approved,
+   * alongside the vendor's identity, contact, and company details.
    * Returns a `status_url` to poll until the export is ready, plus a
    * `download_url` and `status_id`.
    */
@@ -1183,6 +1200,25 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * List a vendor's target-facility screening questions and answers
+   *
+   * @remarks
+   * Returns every active target-facility screening question that currently applies to the vendor at the given facility, each paired with the vendor's answer when one has been given. Questions that have not been answered are included with a null answer. Read-only; used to review a rep's screening answers.
+   */
+  async getVendorScreeningQuestions(
+    request: operations.GetVendorScreeningQuestionsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.GetVendorScreeningQuestionsGetVendorScreeningQuestionsOk
+  > {
+    return unwrapAsync(vendorsGetVendorScreeningQuestions(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get the next unanswered screening question
    *