@greensecurity/javascript-sdk 0.43.1-beta.98 → 0.44.0-beta.1

package/src/models/operations/updatevendordetails.ts

@@ -8,7 +8,15 @@ import { ClosedEnum } from "../../types/enums.js";
 import * as components from "../components/index.js";
 
 /**
- * The vendor's email_recepient value to update
+ * **Deprecated.** Use `PUT /api/users/:id` with
+ *
+ * @remarks
+ * `email_preferences.notification_recipients` instead.
+ * The handler dual-writes to the user-side field during the
+ * migration window; this field will be removed once SDK
+ * consumers migrate.
+ *
+ * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export const EmailRecepient = {
   NoEmail: "No email",
@@ -17,7 +25,15 @@ export const EmailRecepient = {
   VendorAndCompanyManager: "Vendor and company manager",
 } as const;
 /**
- * The vendor's email_recepient value to update
+ * **Deprecated.** Use `PUT /api/users/:id` with
+ *
+ * @remarks
+ * `email_preferences.notification_recipients` instead.
+ * The handler dual-writes to the user-side field during the
+ * migration window; this field will be removed once SDK
+ * consumers migrate.
+ *
+ * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export type EmailRecepient = ClosedEnum<typeof EmailRecepient>;
 
@@ -27,11 +43,27 @@ export type UpdateVendorDetailsRequestBody = {
    */
   qrCode?: string | undefined;
   /**
-   * The vendor's email_recepient value to update
+   * **Deprecated.** Use `PUT /api/users/:id` with
+   *
+   * @remarks
+   * `email_preferences.notification_recipients` instead.
+   * The handler dual-writes to the user-side field during the
+   * migration window; this field will be removed once SDK
+   * consumers migrate.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   emailRecepient?: EmailRecepient | undefined;
   /**
-   * The vendor's send_weekly_summary_email value to update
+   * **Deprecated.** Use `PUT /api/users/:id` with
+   *
+   * @remarks
+   * `email_preferences.send_weekly_summary_email` instead.
+   * The handler dual-writes to the user-side field during the
+   * migration window; this field will be removed once SDK
+   * consumers migrate.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   sendWeeklySummaryEmail?: boolean | undefined;
   /**
@@ -54,7 +86,13 @@ export type UpdateVendorDetailsRequestBody = {
 
 export type UpdateVendorDetailsRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   requestBody: UpdateVendorDetailsRequestBody;

package/src/models/operations/updatevendorfield.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type UpdateVendorFieldRequestBody = {
+  /**
+   * Whether to show this field to vendors
+   */
+  showToVendor: boolean;
+  /**
+   * Required for API users. The user ID to act on behalf of.
+   *
+   * @remarks
+   */
+  sourceUserId?: number | undefined;
+};
+
+export type UpdateVendorFieldRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  requestBody: UpdateVendorFieldRequestBody;
+};
+
+/**
+ * The vendor field was updated successfully.
+ */
+export type UpdateVendorFieldResponseBody = {
+  id?: number | undefined;
+  showToVendor?: boolean | undefined;
+};
+
+/** @internal */
+export type UpdateVendorFieldRequestBody$Outbound = {
+  show_to_vendor: boolean;
+  source_user_id?: number | undefined;
+};
+
+/** @internal */
+export const UpdateVendorFieldRequestBody$outboundSchema: z.ZodType<
+  UpdateVendorFieldRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateVendorFieldRequestBody
+> = z.object({
+  showToVendor: z.boolean(),
+  sourceUserId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    showToVendor: "show_to_vendor",
+    sourceUserId: "source_user_id",
+  });
+});
+
+export function updateVendorFieldRequestBodyToJSON(
+  updateVendorFieldRequestBody: UpdateVendorFieldRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateVendorFieldRequestBody$outboundSchema.parse(
+      updateVendorFieldRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateVendorFieldRequest$Outbound = {
+  id: number;
+  RequestBody: UpdateVendorFieldRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateVendorFieldRequest$outboundSchema: z.ZodType<
+  UpdateVendorFieldRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateVendorFieldRequest
+> = z.object({
+  id: z.number().int(),
+  requestBody: z.lazy(() => UpdateVendorFieldRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateVendorFieldRequestToJSON(
+  updateVendorFieldRequest: UpdateVendorFieldRequest,
+): string {
+  return JSON.stringify(
+    UpdateVendorFieldRequest$outboundSchema.parse(updateVendorFieldRequest),
+  );
+}
+
+/** @internal */
+export const UpdateVendorFieldResponseBody$inboundSchema: z.ZodType<
+  UpdateVendorFieldResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  show_to_vendor: types.optional(types.boolean()),
+}).transform((v) => {
+  return remap$(v, {
+    "show_to_vendor": "showToVendor",
+  });
+});
+
+export function updateVendorFieldResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateVendorFieldResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateVendorFieldResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateVendorFieldResponseBody' from JSON`,
+  );
+}

package/src/models/operations/updatevendormanagedbycompany.ts

@@ -46,7 +46,13 @@ export type UpdateVendorManagedByCompanyRequestBody = {
 
 export type UpdateVendorManagedByCompanyRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   requestBody: UpdateVendorManagedByCompanyRequestBody;

package/src/models/operations/updatevendorscrubdetails.ts

@@ -64,7 +64,13 @@ export type UpdateVendorScrubDetailsRequestBody = {
 
 export type UpdateVendorScrubDetailsRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   requestBody: UpdateVendorScrubDetailsRequestBody;

package/src/models/operations/vendorscanout.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
@@ -21,6 +22,10 @@ export type VendorScanOutRequest = {
 export type VendorScanOutVendorScanOutOk = {
   error?: string | null | undefined;
   reason?: string | null | undefined;
+  /**
+   * Smart badge LED payload data. Only present when the scan-out response can update a smart badge locally.
+   */
+  badgeData?: string | null | undefined;
   success: boolean;
 };
 
@@ -54,7 +59,12 @@ export const VendorScanOutVendorScanOutOk$inboundSchema: z.ZodType<
 > = z.object({
   error: z.nullable(types.string()).optional(),
   reason: z.nullable(types.string()).optional(),
+  badge_data: z.nullable(types.string()).optional(),
   success: types.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "badge_data": "badgeData",
+  });
 });
 
 export function vendorScanOutVendorScanOutOkFromJSON(

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

@@ -78,6 +78,7 @@ export function buildAlertsListAlertsQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       userIdOrMe: request.userIdOrMe,
+      alertType: request.alertType,
     }),
     queryFn: async function alertsListAlertsQueryFn(
       ctx,
@@ -119,6 +120,7 @@ export function buildAlertsListAlertsInfiniteQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       userIdOrMe: request.userIdOrMe,
+      alertType: request.alertType,
     }),
     queryFn: async function alertsListAlertsQuery(
       ctx,
@@ -157,6 +159,7 @@ export function queryKeyAlertsListAlerts(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     userIdOrMe?: string | undefined;
+    alertType?: operations.AlertType | undefined;
   },
 ): QueryKey {
   return ["@greensecurity/javascript-sdk", "alerts", "listAlerts", parameters];
@@ -169,6 +172,7 @@ export function queryKeyAlertsListAlertsInfinite(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     userIdOrMe?: string | undefined;
+    alertType?: operations.AlertType | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/alertsListAlerts.ts

@@ -201,6 +201,7 @@ export function setAlertsListAlertsData(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       userIdOrMe?: string | undefined;
+      alertType?: operations.AlertType | undefined;
     },
   ],
   data: AlertsListAlertsQueryData,
@@ -219,6 +220,7 @@ export function invalidateAlertsListAlerts(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       userIdOrMe?: string | undefined;
+      alertType?: operations.AlertType | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,

package/src/react-query/companiesAddCompanyManager.ts

@@ -0,0 +1,114 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesAddCompanyManager } from "../funcs/companiesAddCompanyManager.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 CompaniesAddCompanyManagerMutationVariables = {
+  request: operations.AddCompanyManagerRequest;
+  options?: RequestOptions;
+};
+
+export type CompaniesAddCompanyManagerMutationData =
+  operations.AddCompanyManagerAddCompanyManagerOk;
+
+export type CompaniesAddCompanyManagerMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Add company manager
+ *
+ * @remarks
+ * Creates a new company manager for the specified company.
+ * A welcome email is sent to the new manager with login instructions.
+ * Requires `company_managers` add permission. Company managers can add to their
+ * own company; API users can add to companies in their marketplace app scope.
+ */
+export function useCompaniesAddCompanyManagerMutation(
+  options?: MutationHookOptions<
+    CompaniesAddCompanyManagerMutationData,
+    CompaniesAddCompanyManagerMutationError,
+    CompaniesAddCompanyManagerMutationVariables
+  >,
+): UseMutationResult<
+  CompaniesAddCompanyManagerMutationData,
+  CompaniesAddCompanyManagerMutationError,
+  CompaniesAddCompanyManagerMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildCompaniesAddCompanyManagerMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyCompaniesAddCompanyManager(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "companies", "addCompanyManager"];
+}
+
+export function buildCompaniesAddCompanyManagerMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: CompaniesAddCompanyManagerMutationVariables,
+  ) => Promise<CompaniesAddCompanyManagerMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyCompaniesAddCompanyManager(),
+    mutationFn: function companiesAddCompanyManagerMutationFn({
+      request,
+      options,
+    }): Promise<CompaniesAddCompanyManagerMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(companiesAddCompanyManager(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

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

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesLookupCompanies } from "../funcs/companiesLookupCompanies.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { pageIteratorToJSON } from "./_types.js";
+export type CompaniesLookupCompaniesQueryData =
+  operations.LookupCompaniesResponse;
+
+export type CompaniesLookupCompaniesInfiniteQueryData = PageIterator<
+  operations.LookupCompaniesResponse,
+  { page: number }
+>;
+
+export type CompaniesLookupCompaniesPageParams = PageIterator<
+  operations.LookupCompaniesResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchCompaniesLookupCompanies(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.LookupCompaniesRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesLookupCompaniesQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchCompaniesLookupCompaniesInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.LookupCompaniesRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildCompaniesLookupCompaniesInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as CompaniesLookupCompaniesPageParams,
+    getNextPageParam: (
+      previousPage: CompaniesLookupCompaniesInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildCompaniesLookupCompaniesQuery(
+  client$: GreenSecurityCore,
+  request: operations.LookupCompaniesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesLookupCompaniesQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesLookupCompanies({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      nameLike: request.nameLike,
+    }),
+    queryFn: async function companiesLookupCompaniesQueryFn(
+      ctx,
+    ): Promise<CompaniesLookupCompaniesQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(companiesLookupCompanies(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildCompaniesLookupCompaniesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.LookupCompaniesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<QueryKey, CompaniesLookupCompaniesPageParams>,
+  ) => Promise<CompaniesLookupCompaniesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesLookupCompaniesInfinite({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      nameLike: request.nameLike,
+    }),
+    queryFn: async function companiesLookupCompaniesQuery(
+      ctx,
+    ): Promise<CompaniesLookupCompaniesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(companiesLookupCompanies(
+          client$,
+          request,
+          mergedOptions,
+        ));
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(companiesLookupCompanies(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyCompaniesLookupCompanies(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    nameLike?: string | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "lookupCompanies",
+    parameters,
+  ];
+}
+
+export function queryKeyCompaniesLookupCompaniesInfinite(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    nameLike?: string | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "lookupCompanies",
+    "infinite",
+    parameters,
+  ];
+}