@greensecurity/javascript-sdk 0.44.0-beta.57 → 0.44.0-beta.59

package/src/react-query/reportsInitiateScheduledReport.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { reportsInitiateScheduledReport } from "../funcs/reportsInitiateScheduledReport.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+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 { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type ReportsInitiateScheduledReportMutationVariables = {
+  request: operations.InitiateScheduledReportRequest;
+  options?: RequestOptions;
+};
+
+export type ReportsInitiateScheduledReportMutationData =
+  operations.InitiateScheduledReportInitiateScheduledReportOk;
+
+export type ReportsInitiateScheduledReportMutationError =
+  | errors.ApiErrorResponse
+  | errors.UnprocessableEntityOrValidationError
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Generate a scheduled report now
+ *
+ * @remarks
+ * Immediately generates a new report run for a scheduled report, independent of its
+ * configured schedule. Returns a `poll_url` for the generated `FullReport`.
+ *
+ * Generation is asynchronous. Poll `GET /reports/{full_report_id}` on the **status code**,
+ * not on a status field: while the run is pending or processing that endpoint returns `409`
+ * with an error envelope and no `status` to read. Retry the `409` until it turns into `200`,
+ * which carries the `full_report` payload and the signed download URL. `409` is the only
+ * retryable status — a canceled or failed run returns `422`, so no error-message matching is
+ * needed to decide when to give up.
+ *
+ * Bound the retries with your own timeout or attempt limit. Report generation has no terminal
+ * failure state today, so a run whose generation crashed stays in `processing` and answers
+ * `409` indefinitely rather than turning into a `422`.
+ *
+ * Access control: the URL's `scheduled_report_id` must be in the caller's read scope
+ * for `ScheduledReport` — the facility or system it belongs to, a scheduled report the
+ * caller is an explicit recipient of, or a scheduled report whose app is activated for
+ * the API user. Callers outside that scope receive `404 Scheduled report not found`.
+ */
+export function useReportsInitiateScheduledReportMutation(
+  options?: MutationHookOptions<
+    ReportsInitiateScheduledReportMutationData,
+    ReportsInitiateScheduledReportMutationError,
+    ReportsInitiateScheduledReportMutationVariables
+  >,
+): UseMutationResult<
+  ReportsInitiateScheduledReportMutationData,
+  ReportsInitiateScheduledReportMutationError,
+  ReportsInitiateScheduledReportMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildReportsInitiateScheduledReportMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyReportsInitiateScheduledReport(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "reports",
+    "initiateScheduledReport",
+  ];
+}
+
+export function buildReportsInitiateScheduledReportMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: ReportsInitiateScheduledReportMutationVariables,
+  ) => Promise<ReportsInitiateScheduledReportMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyReportsInitiateScheduledReport(),
+    mutationFn: function reportsInitiateScheduledReportMutationFn({
+      request,
+      options,
+    }): Promise<ReportsInitiateScheduledReportMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(reportsInitiateScheduledReport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

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

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansVendorScanGpsCheckoutConfig } from "../funcs/vendorScansVendorScanGpsCheckoutConfig.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type VendorScansVendorScanGpsCheckoutConfigQueryData =
+  operations.VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk;
+
+export function prefetchVendorScansVendorScanGpsCheckoutConfig(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.VendorScanGpsCheckoutConfigRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansVendorScanGpsCheckoutConfigQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorScansVendorScanGpsCheckoutConfigQuery(
+  client$: GreenSecurityCore,
+  request: operations.VendorScanGpsCheckoutConfigRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansVendorScanGpsCheckoutConfigQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansVendorScanGpsCheckoutConfig(request.id),
+    queryFn: async function vendorScansVendorScanGpsCheckoutConfigQueryFn(
+      ctx,
+    ): Promise<VendorScansVendorScanGpsCheckoutConfigQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansVendorScanGpsCheckoutConfig(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorScansVendorScanGpsCheckoutConfig(
+  id: number,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "vendorScanGpsCheckoutConfig",
+    id,
+  ];
+}

package/src/react-query/vendorScansVendorScanGpsCheckoutConfig.ts

@@ -0,0 +1,150 @@
+/*
+ * 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 {
+  buildVendorScansVendorScanGpsCheckoutConfigQuery,
+  prefetchVendorScansVendorScanGpsCheckoutConfig,
+  queryKeyVendorScansVendorScanGpsCheckoutConfig,
+  VendorScansVendorScanGpsCheckoutConfigQueryData,
+} from "./vendorScansVendorScanGpsCheckoutConfig.core.js";
+export {
+  buildVendorScansVendorScanGpsCheckoutConfigQuery,
+  prefetchVendorScansVendorScanGpsCheckoutConfig,
+  queryKeyVendorScansVendorScanGpsCheckoutConfig,
+  type VendorScansVendorScanGpsCheckoutConfigQueryData,
+};
+
+export type VendorScansVendorScanGpsCheckoutConfigQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Automatic GPS check-out configuration
+ *
+ * @remarks
+ * Returns the geofence a client should arm to detect that the vendor has left the location this scan belongs to. A facility that has automatic GPS check-out configured owns the geofence for every one of its zones; only when it does not does the zone's own setting apply.
+ */
+export function useVendorScansVendorScanGpsCheckoutConfig(
+  request: operations.VendorScanGpsCheckoutConfigRequest,
+  options?: QueryHookOptions<
+    VendorScansVendorScanGpsCheckoutConfigQueryData,
+    VendorScansVendorScanGpsCheckoutConfigQueryError
+  >,
+): UseQueryResult<
+  VendorScansVendorScanGpsCheckoutConfigQueryData,
+  VendorScansVendorScanGpsCheckoutConfigQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorScansVendorScanGpsCheckoutConfigQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Automatic GPS check-out configuration
+ *
+ * @remarks
+ * Returns the geofence a client should arm to detect that the vendor has left the location this scan belongs to. A facility that has automatic GPS check-out configured owns the geofence for every one of its zones; only when it does not does the zone's own setting apply.
+ */
+export function useVendorScansVendorScanGpsCheckoutConfigSuspense(
+  request: operations.VendorScanGpsCheckoutConfigRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorScansVendorScanGpsCheckoutConfigQueryData,
+    VendorScansVendorScanGpsCheckoutConfigQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorScansVendorScanGpsCheckoutConfigQueryData,
+  VendorScansVendorScanGpsCheckoutConfigQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorScansVendorScanGpsCheckoutConfigQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorScansVendorScanGpsCheckoutConfigData(
+  client: QueryClient,
+  queryKeyBase: [id: number],
+  data: VendorScansVendorScanGpsCheckoutConfigQueryData,
+): VendorScansVendorScanGpsCheckoutConfigQueryData | undefined {
+  const key = queryKeyVendorScansVendorScanGpsCheckoutConfig(...queryKeyBase);
+
+  return client.setQueryData<VendorScansVendorScanGpsCheckoutConfigQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorScansVendorScanGpsCheckoutConfig(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "vendorScanGpsCheckoutConfig",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorScansVendorScanGpsCheckoutConfig(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "vendorScanGpsCheckoutConfig",
+    ],
+  });
+}

package/src/react-query/vendorScansVendorScanGpsScanOut.ts

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansVendorScanGpsScanOut } from "../funcs/vendorScansVendorScanGpsScanOut.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+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 { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type VendorScansVendorScanGpsScanOutMutationVariables = {
+  request: operations.VendorScanGpsScanOutRequest;
+  options?: RequestOptions;
+};
+
+export type VendorScansVendorScanGpsScanOutMutationData =
+  operations.VendorScanGpsScanOutVendorScanGpsScanOutOk;
+
+export type VendorScansVendorScanGpsScanOutMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Automatic GPS check-out
+ *
+ * @remarks
+ * Reports the device's current position and scans the vendor out when it lies outside the geofence returned by the GPS check-out configuration endpoint. The distance is always recomputed server-side. Reporting the same exit twice is a no-op.
+ *
+ * When an accuracy radius is supplied it is discounted from the distance before the comparison. The vendor is checked out only when the entire error margin clears the geofence AND the reported accuracy is at most 328 ft (100 m). When only half the margin clears it — or the margin clears it entirely but is wider than that ceiling — the visit is left open and the vendor is sent a reminder to check out instead, once per check-in; the response then reports `success: false` with `outcome: possibly_left`.
+ */
+export function useVendorScansVendorScanGpsScanOutMutation(
+  options?: MutationHookOptions<
+    VendorScansVendorScanGpsScanOutMutationData,
+    VendorScansVendorScanGpsScanOutMutationError,
+    VendorScansVendorScanGpsScanOutMutationVariables
+  >,
+): UseMutationResult<
+  VendorScansVendorScanGpsScanOutMutationData,
+  VendorScansVendorScanGpsScanOutMutationError,
+  VendorScansVendorScanGpsScanOutMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorScansVendorScanGpsScanOutMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorScansVendorScanGpsScanOut(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "vendorScanGpsScanOut",
+  ];
+}
+
+export function buildVendorScansVendorScanGpsScanOutMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorScansVendorScanGpsScanOutMutationVariables,
+  ) => Promise<VendorScansVendorScanGpsScanOutMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorScansVendorScanGpsScanOut(),
+    mutationFn: function vendorScansVendorScanGpsScanOutMutationFn({
+      request,
+      options,
+    }): Promise<VendorScansVendorScanGpsScanOutMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorScansVendorScanGpsScanOut(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorsUpdateVendorDetails.ts

@@ -49,7 +49,20 @@ export type VendorsUpdateVendorDetailsMutationError =
  * Update vendor details
  *
  * @remarks
- * Update an individual vendor's profile — title, location, supervisor, email preferences, primary department, and primary sales state. A company manager can also remove the vendor from their company by sending `company_id: null`.
+ * Update an individual vendor's profile — title, location, supervisor, email
+ * preferences, primary department, and primary sales state. A company manager
+ * can also remove the vendor from their company by sending `company_id: null`.
+ *
+ * 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.
+ *
+ * For `title`, the `supervisor` fields, and every `location` field except
+ * `timezone`, the value sent is the value stored: omit a field to leave it
+ * unchanged, or send an empty string to clear it. `timezone` is the one
+ * exception — it accepts only the values in its enum, so send one of those to
+ * change it and omit it to leave it unchanged.
  */
 export function useVendorsUpdateVendorDetailsMutation(
   options?: MutationHookOptions<

package/src/sdk/reports.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { reportsGetFullReport } from "../funcs/reportsGetFullReport.js";
+import { reportsInitiateScheduledReport } from "../funcs/reportsInitiateScheduledReport.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Reports extends ClientSDK {
+  /**
+   * Generate a scheduled report now
+   *
+   * @remarks
+   * Immediately generates a new report run for a scheduled report, independent of its
+   * configured schedule. Returns a `poll_url` for the generated `FullReport`.
+   *
+   * Generation is asynchronous. Poll `GET /reports/{full_report_id}` on the **status code**,
+   * not on a status field: while the run is pending or processing that endpoint returns `409`
+   * with an error envelope and no `status` to read. Retry the `409` until it turns into `200`,
+   * which carries the `full_report` payload and the signed download URL. `409` is the only
+   * retryable status — a canceled or failed run returns `422`, so no error-message matching is
+   * needed to decide when to give up.
+   *
+   * Bound the retries with your own timeout or attempt limit. Report generation has no terminal
+   * failure state today, so a run whose generation crashed stays in `processing` and answers
+   * `409` indefinitely rather than turning into a `422`.
+   *
+   * Access control: the URL's `scheduled_report_id` must be in the caller's read scope
+   * for `ScheduledReport` — the facility or system it belongs to, a scheduled report the
+   * caller is an explicit recipient of, or a scheduled report whose app is activated for
+   * the API user. Callers outside that scope receive `404 Scheduled report not found`.
+   */
+  async initiateScheduledReport(
+    request: operations.InitiateScheduledReportRequest,
+    options?: RequestOptions,
+  ): Promise<operations.InitiateScheduledReportInitiateScheduledReportOk> {
+    return unwrapAsync(reportsInitiateScheduledReport(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a generated report's status and download URL
+   *
+   * @remarks
+   * Returns a completed report run and a short-lived signed `report_url` (valid 5 minutes).
+   *
+   * Only a completed run returns the `full_report` payload. A run that has not finished does
+   * **not** come back with a `status` field to inspect — it returns an error envelope. Poll on
+   * the status code alone; `409` is the only retryable outcome, so no error-message matching is
+   * needed:
+   *
+   * | Status | Meaning | What to do |
+   * | --- | --- | --- |
+   * | `200` | The run finished. | Download `full_report.report_url` within 5 minutes. |
+   * | `409` | Still pending or processing. | Retry, but bound it — see below. |
+   * | `422` | Terminal: the run was canceled or failed, or the id is not a positive integer. | Stop. |
+   * | `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
+   * 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
+   * `FullReport` — the facility or system it was run for, a recipient of the schedule that
+   * produced it, or a report whose app is activated for the API user. Callers outside that
+   * scope receive `404 Full report not found`.
+   */
+  async getFullReport(
+    request: operations.GetFullReportRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetFullReportGetFullReportOk> {
+    return unwrapAsync(reportsGetFullReport(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -16,6 +16,7 @@ import { Lookups } from "./lookups.js";
 import { MobileDevices } from "./mobiledevices.js";
 import { Organizations } from "./organizations.js";
 import { PaymentProfile } from "./paymentprofile.js";
+import { Reports } from "./reports.js";
 import { SupportArticles } from "./supportarticles.js";
 import { Systems } from "./systems.js";
 import { Users } from "./users.js";
@@ -116,6 +117,11 @@ export class GreenSecurity extends ClientSDK {
     return (this._lookups ??= new Lookups(this._options));
   }
 
+  private _reports?: Reports;
+  get reports(): Reports {
+    return (this._reports ??= new Reports(this._options));
+  }
+
   async validateWebhook({
     request,
     secret,

package/src/sdk/vendors.ts

@@ -867,7 +867,20 @@ export class Vendors extends ClientSDK {
    * Update vendor details
    *
    * @remarks
-   * Update an individual vendor's profile — title, location, supervisor, email preferences, primary department, and primary sales state. A company manager can also remove the vendor from their company by sending `company_id: null`.
+   * Update an individual vendor's profile — title, location, supervisor, email
+   * preferences, primary department, and primary sales state. A company manager
+   * can also remove the vendor from their company by sending `company_id: null`.
+   *
+   * 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.
+   *
+   * For `title`, the `supervisor` fields, and every `location` field except
+   * `timezone`, the value sent is the value stored: omit a field to leave it
+   * unchanged, or send an empty string to clear it. `timezone` is the one
+   * exception — it accepts only the values in its enum, so send one of those to
+   * change it and omit it to leave it unchanged.
    */
   async updateVendorDetails(
     request: operations.UpdateVendorDetailsRequest,

package/src/sdk/vendorscans.ts

@@ -12,6 +12,8 @@ import { vendorScansGetVendorScan } from "../funcs/vendorScansGetVendorScan.js";
 import { vendorScansGetVendorScansExportStatus } from "../funcs/vendorScansGetVendorScansExportStatus.js";
 import { vendorScansListVendorScans } from "../funcs/vendorScansListVendorScans.js";
 import { vendorScansSubmitScreeningResponse } from "../funcs/vendorScansSubmitScreeningResponse.js";
+import { vendorScansVendorScanGpsCheckoutConfig } from "../funcs/vendorScansVendorScanGpsCheckoutConfig.js";
+import { vendorScansVendorScanGpsScanOut } from "../funcs/vendorScansVendorScanGpsScanOut.js";
 import { vendorScansVendorScanOut } from "../funcs/vendorScansVendorScanOut.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -193,4 +195,42 @@ export class VendorScans extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Automatic GPS check-out configuration
+   *
+   * @remarks
+   * Returns the geofence a client should arm to detect that the vendor has left the location this scan belongs to. A facility that has automatic GPS check-out configured owns the geofence for every one of its zones; only when it does not does the zone's own setting apply.
+   */
+  async vendorScanGpsCheckoutConfig(
+    request: operations.VendorScanGpsCheckoutConfigRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk
+  > {
+    return unwrapAsync(vendorScansVendorScanGpsCheckoutConfig(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Automatic GPS check-out
+   *
+   * @remarks
+   * Reports the device's current position and scans the vendor out when it lies outside the geofence returned by the GPS check-out configuration endpoint. The distance is always recomputed server-side. Reporting the same exit twice is a no-op.
+   *
+   * When an accuracy radius is supplied it is discounted from the distance before the comparison. The vendor is checked out only when the entire error margin clears the geofence AND the reported accuracy is at most 328 ft (100 m). When only half the margin clears it — or the margin clears it entirely but is wider than that ceiling — the visit is left open and the vendor is sent a reminder to check out instead, once per check-in; the response then reports `success: false` with `outcome: possibly_left`.
+   */
+  async vendorScanGpsScanOut(
+    request: operations.VendorScanGpsScanOutRequest,
+    options?: RequestOptions,
+  ): Promise<operations.VendorScanGpsScanOutVendorScanGpsScanOutOk> {
+    return unwrapAsync(vendorScansVendorScanGpsScanOut(
+      this,
+      request,
+      options,
+    ));
+  }
 }