@greensecurity/javascript-sdk 0.43.1-beta.120 → 0.43.1-beta.123

package/src/models/operations/listvendorcustomfields.ts

@@ -12,48 +12,26 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListVendorCustomFieldsRequest = {
   /**
-   * A comma-separated list of object attributes to sort on.
-   */
-  sort?: string | null | undefined;
-  /**
-   * Sort desc
-   */
-  desc?: components.Desc | undefined;
-  /**
-   * A 1-based offset for which page to request (defaults to 1)
-   */
-  page?: number | undefined;
-  /**
-   * Number of items to show in a given page
-   */
-  itemsPerPage?: number | undefined;
-  /**
-   * 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;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * The request was successful.
  */
 export type ListVendorCustomFieldsListVendorCustomFieldsOk = {
   items: Array<components.VendorCustomFields>;
-  /**
-   * Pagination information for a pageable list
-   */
-  pager: components.Pager;
-};
-
-export type ListVendorCustomFieldsResponse = {
-  result: ListVendorCustomFieldsListVendorCustomFieldsOk;
 };
 
 /** @internal */
 export type ListVendorCustomFieldsRequest$Outbound = {
-  sort?: string | null | undefined;
-  desc?: components.Desc$Outbound | undefined;
-  page?: number | undefined;
-  items_per_page?: number | undefined;
   vendor_id_or_me: string;
 };
 
@@ -63,14 +41,9 @@ export const ListVendorCustomFieldsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListVendorCustomFieldsRequest
 > = z.object({
-  sort: z.nullable(z.string()).optional(),
-  desc: components.Desc$outboundSchema.optional(),
-  page: z.number().int().optional(),
-  itemsPerPage: z.number().int().optional(),
   vendorIdOrMe: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    itemsPerPage: "items_per_page",
     vendorIdOrMe: "vendor_id_or_me",
   });
 });
@@ -93,7 +66,6 @@ export const ListVendorCustomFieldsListVendorCustomFieldsOk$inboundSchema:
     unknown
   > = z.object({
     items: z.array(components.VendorCustomFields$inboundSchema),
-    pager: components.Pager$inboundSchema,
   });
 
 export function listVendorCustomFieldsListVendorCustomFieldsOkFromJSON(
@@ -111,28 +83,3 @@ export function listVendorCustomFieldsListVendorCustomFieldsOkFromJSON(
     `Failed to parse 'ListVendorCustomFieldsListVendorCustomFieldsOk' from JSON`,
   );
 }
-
-/** @internal */
-export const ListVendorCustomFieldsResponse$inboundSchema: z.ZodType<
-  ListVendorCustomFieldsResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  Result: z.lazy(() =>
-    ListVendorCustomFieldsListVendorCustomFieldsOk$inboundSchema
-  ),
-}).transform((v) => {
-  return remap$(v, {
-    "Result": "result",
-  });
-});
-
-export function listVendorCustomFieldsResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<ListVendorCustomFieldsResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ListVendorCustomFieldsResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ListVendorCustomFieldsResponse' from JSON`,
-  );
-}

package/src/models/operations/listvendorfacilitystatuses.ts

@@ -12,7 +12,13 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListVendorFacilityStatusesRequest = {
   /**
-   * 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;
   /**

package/src/models/operations/listvendorinvoices.ts

@@ -33,7 +33,13 @@ export type ListVendorInvoicesRequest = {
    */
   expand?: Array<components.Expand> | undefined;
   /**
-   * 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;
   /**

package/src/models/operations/listvendormanagedbycompanies.ts

@@ -29,7 +29,13 @@ export type ListVendorManagedByCompaniesRequest = {
    */
   itemsPerPage?: number | undefined;
   /**
-   * 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;
 };

package/src/models/operations/listvendorscans.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 55982c508708
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter by scan type. One of: `in`, `out`, `spot_check`.
+ */
+export const ScanType = {
+  In: "in",
+  Out: "out",
+  SpotCheck: "spot_check",
+} as const;
+/**
+ * Filter by scan type. One of: `in`, `out`, `spot_check`.
+ */
+export type ScanType = ClosedEnum<typeof ScanType>;
+
+export type ListVendorScansRequest = {
+  /**
+   * A comma-separated list of object attributes to sort on.
+   */
+  sort?: string | null | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * An ID representing a Hospital
+   */
+  facilityId?: number | undefined;
+  /**
+   * An ID representing a Hospital System
+   */
+  systemId?: number | undefined;
+  /**
+   * Filter scans by company ID.
+   */
+  companyId?: number | undefined;
+  /**
+   * Filter scans by vendor ID, or pass `me` to use the currently authenticated vendor.
+   */
+  vendorId?: string | undefined;
+  /**
+   * Filter by scan type. One of: `in`, `out`, `spot_check`.
+   */
+  scanType?: ScanType | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListVendorScansListVendorScansOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.VendorScan | null>;
+};
+
+export type ListVendorScansResponse = {
+  result: ListVendorScansListVendorScansOk;
+};
+
+/** @internal */
+export const ScanType$outboundSchema: z.ZodNativeEnum<typeof ScanType> = z
+  .nativeEnum(ScanType);
+
+/** @internal */
+export type ListVendorScansRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  facility_id?: number | undefined;
+  system_id?: number | undefined;
+  company_id?: number | undefined;
+  vendor_id?: string | undefined;
+  scan_type?: string | undefined;
+};
+
+/** @internal */
+export const ListVendorScansRequest$outboundSchema: z.ZodType<
+  ListVendorScansRequest$Outbound,
+  z.ZodTypeDef,
+  ListVendorScansRequest
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  facilityId: z.number().int().optional(),
+  systemId: z.number().int().optional(),
+  companyId: z.number().int().optional(),
+  vendorId: z.string().optional(),
+  scanType: ScanType$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    facilityId: "facility_id",
+    systemId: "system_id",
+    companyId: "company_id",
+    vendorId: "vendor_id",
+    scanType: "scan_type",
+  });
+});
+
+export function listVendorScansRequestToJSON(
+  listVendorScansRequest: ListVendorScansRequest,
+): string {
+  return JSON.stringify(
+    ListVendorScansRequest$outboundSchema.parse(listVendorScansRequest),
+  );
+}
+
+/** @internal */
+export const ListVendorScansListVendorScansOk$inboundSchema: z.ZodType<
+  ListVendorScansListVendorScansOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(types.nullable(components.VendorScan$inboundSchema)),
+});
+
+export function listVendorScansListVendorScansOkFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorScansListVendorScansOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorScansListVendorScansOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorScansListVendorScansOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListVendorScansResponse$inboundSchema: z.ZodType<
+  ListVendorScansResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListVendorScansListVendorScansOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listVendorScansResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorScansResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorScansResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorScansResponse' from JSON`,
+  );
+}

package/src/models/operations/listvendorscrubdetails.ts

@@ -8,7 +8,13 @@ import { remap as remap$ } from "../../lib/primitives.js";
 
 export type ListVendorScrubDetailsRequest = {
   /**
-   * 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;
 };

package/src/models/operations/listvendorscrubpackages.ts

@@ -29,7 +29,13 @@ export type ListVendorScrubPackagesRequest = {
    */
   itemsPerPage?: number | undefined;
   /**
-   * 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;
 };

package/src/models/operations/listvendorscrubpurchases.ts

@@ -28,7 +28,13 @@ export type ListVendorScrubPurchasesRequest = {
    */
   itemsPerPage?: number | undefined;
   /**
-   * 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;
 };

package/src/models/operations/purchasescrubcredits.ts

@@ -17,7 +17,13 @@ export type PurchaseScrubCreditsRequestBody = {
 
 export type PurchaseScrubCreditsRequest = {
   /**
-   * 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: PurchaseScrubCreditsRequestBody;

package/src/models/operations/updatevendorcredentialdata.ts

@@ -49,7 +49,13 @@ export type UpdateVendorCredentialDataRequestBody = {
 
 export type UpdateVendorCredentialDataRequest = {
   /**
-   * 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;
   /**

package/src/models/operations/updatevendorcustomfield.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 061eaa96d71c
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type UpdateVendorCustomFieldRequestBody = {
+  /**
+   * The ID of the vendor field to update
+   */
+  vendorFieldId: number;
+  /**
+   * The new value for the field
+   */
+  value: string | null;
+};
+
+export type UpdateVendorCustomFieldRequest = {
+  /**
+   * 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: UpdateVendorCustomFieldRequestBody;
+};
+
+/** @internal */
+export type UpdateVendorCustomFieldRequestBody$Outbound = {
+  vendor_field_id: number;
+  value: string | null;
+};
+
+/** @internal */
+export const UpdateVendorCustomFieldRequestBody$outboundSchema: z.ZodType<
+  UpdateVendorCustomFieldRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateVendorCustomFieldRequestBody
+> = z.object({
+  vendorFieldId: z.number().int(),
+  value: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    vendorFieldId: "vendor_field_id",
+  });
+});
+
+export function updateVendorCustomFieldRequestBodyToJSON(
+  updateVendorCustomFieldRequestBody: UpdateVendorCustomFieldRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateVendorCustomFieldRequestBody$outboundSchema.parse(
+      updateVendorCustomFieldRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateVendorCustomFieldRequest$Outbound = {
+  vendor_id_or_me: string;
+  RequestBody: UpdateVendorCustomFieldRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateVendorCustomFieldRequest$outboundSchema: z.ZodType<
+  UpdateVendorCustomFieldRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateVendorCustomFieldRequest
+> = z.object({
+  vendorIdOrMe: z.string(),
+  requestBody: z.lazy(() => UpdateVendorCustomFieldRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    vendorIdOrMe: "vendor_id_or_me",
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateVendorCustomFieldRequestToJSON(
+  updateVendorCustomFieldRequest: UpdateVendorCustomFieldRequest,
+): string {
+  return JSON.stringify(
+    UpdateVendorCustomFieldRequest$outboundSchema.parse(
+      updateVendorCustomFieldRequest,
+    ),
+  );
+}

package/src/models/operations/updatevendordetails.ts

@@ -55,7 +55,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/updatevendormanagedbycompany.ts

@@ -47,7 +47,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

@@ -65,7 +65,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/react-query/eventsGetEvent.core.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 18f0158e5fe5
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { eventsGetEvent } from "../funcs/eventsGetEvent.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";
+export type EventsGetEventQueryData = operations.GetEventGetEventOk;
+
+export function prefetchEventsGetEvent(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetEventRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildEventsGetEventQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildEventsGetEventQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetEventRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<EventsGetEventQueryData>;
+} {
+  return {
+    queryKey: queryKeyEventsGetEvent(request.id, { expand: request.expand }),
+    queryFn: async function eventsGetEventQueryFn(
+      ctx,
+    ): Promise<EventsGetEventQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(eventsGetEvent(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyEventsGetEvent(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "events",
+    "getEvent",
+    id,
+    parameters,
+  ];
+}