@greensecurity/javascript-sdk 0.45.0-beta.1 → 0.45.0-beta.11

package/src/react-query/usersUpdateUser.ts

@@ -56,6 +56,12 @@ export type UsersUpdateUserMutationError =
  * 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.

package/src/react-query/vendorsCreateVendor.ts

@@ -55,6 +55,10 @@ export type VendorsCreateVendorMutationError =
  * `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.
  */
 export function useVendorsCreateVendorMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsGetVendorCredentialDetails.ts

@@ -63,6 +63,7 @@ export type VendorsGetVendorCredentialDetailsQueryError =
  *   - 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
@@ -118,6 +119,7 @@ export function useVendorsGetVendorCredentialDetails(
  *   - 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

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/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/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.

package/src/sdk/vendors.ts

@@ -132,6 +132,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 +277,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 +884,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 +1091,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`.
    */