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

package/src/models/operations/listvendors.ts

@@ -0,0 +1,239 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Sort column. vendor_field_value requires company_id.
+ *
+ * @remarks
+ * last_scanned and date_ends use LATERAL JOINs added automatically when the sort key is present.
+ */
+export const Sort = {
+  FullName: "full_name",
+  VendorType: "vendor_type",
+  LastScanned: "last_scanned",
+  VendorFieldValue: "vendor_field_value",
+  SubscriptionStatus: "subscription_status",
+  DateEnds: "date_ends",
+} as const;
+/**
+ * Sort column. vendor_field_value requires company_id.
+ *
+ * @remarks
+ * last_scanned and date_ends use LATERAL JOINs added automatically when the sort key is present.
+ */
+export type Sort = ClosedEnum<typeof Sort>;
+
+export type ListVendorsRequest = {
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | undefined;
+  /**
+   * Sort column. vendor_field_value requires company_id.
+   *
+   * @remarks
+   * last_scanned and date_ends use LATERAL JOINs added automatically when the sort key is present.
+   */
+  sort?: Sort | 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;
+  /**
+   * Filter vendors by company. Required when using vendor_field_value sort or vendor_field_value_like filter.
+   */
+  companyId?: number | undefined;
+  /**
+   * Search by first name, last name, or full name (case-insensitive contains).
+   */
+  fullNameLike?: string | undefined;
+  companyNameLike?: string | undefined;
+  firstNameLike?: string | undefined;
+  lastNameLike?: string | undefined;
+  emailLike?: string | undefined;
+  status?: string | undefined;
+  credentialingSubscriptionStatus?: string | undefined;
+  scrubsSubscriptionStatus?: string | undefined;
+  /**
+   * Filter by vendor_types.short_name (case-insensitive contains). Comma-separated for multiple values.
+   */
+  vendorTypeLike?: string | undefined;
+  /**
+   * Filter by vendor field value (case-insensitive contains). Requires company_id.
+   */
+  vendorFieldValueLike?: string | undefined;
+  /**
+   * Filter vendors with last scan date on or after this date (YYYY-MM-DD).
+   */
+  dateScannedGte?: string | undefined;
+  /**
+   * Filter vendors with last scan date on or before this date (YYYY-MM-DD).
+   */
+  dateScannedLte?: string | undefined;
+  /**
+   * Filter vendors whose credentialing subscription date_ends is on or after this date (YYYY-MM-DD).
+   */
+  dateEndsGte?: string | undefined;
+  /**
+   * Filter vendors whose credentialing subscription date_ends is on or before this date (YYYY-MM-DD).
+   */
+  dateEndsLte?: string | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListVendorsListVendorsOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.Vendor>;
+};
+
+export type ListVendorsResponse = {
+  result: ListVendorsListVendorsOk;
+};
+
+/** @internal */
+export const Sort$outboundSchema: z.ZodNativeEnum<typeof Sort> = z.nativeEnum(
+  Sort,
+);
+
+/** @internal */
+export type ListVendorsRequest$Outbound = {
+  expand?: Array<string> | undefined;
+  sort?: string | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  company_id?: number | undefined;
+  full_name_like?: string | undefined;
+  company_name_like?: string | undefined;
+  first_name_like?: string | undefined;
+  last_name_like?: string | undefined;
+  email_like?: string | undefined;
+  status?: string | undefined;
+  credentialing_subscription_status?: string | undefined;
+  scrubs_subscription_status?: string | undefined;
+  vendor_type_like?: string | undefined;
+  vendor_field_value_like?: string | undefined;
+  date_scanned_gte?: string | undefined;
+  date_scanned_lte?: string | undefined;
+  date_ends_gte?: string | undefined;
+  date_ends_lte?: string | undefined;
+};
+
+/** @internal */
+export const ListVendorsRequest$outboundSchema: z.ZodType<
+  ListVendorsRequest$Outbound,
+  z.ZodTypeDef,
+  ListVendorsRequest
+> = z.object({
+  expand: z.array(components.Expand$outboundSchema).optional(),
+  sort: Sort$outboundSchema.optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  companyId: z.number().int().optional(),
+  fullNameLike: z.string().optional(),
+  companyNameLike: z.string().optional(),
+  firstNameLike: z.string().optional(),
+  lastNameLike: z.string().optional(),
+  emailLike: z.string().optional(),
+  status: z.string().optional(),
+  credentialingSubscriptionStatus: z.string().optional(),
+  scrubsSubscriptionStatus: z.string().optional(),
+  vendorTypeLike: z.string().optional(),
+  vendorFieldValueLike: z.string().optional(),
+  dateScannedGte: z.string().optional(),
+  dateScannedLte: z.string().optional(),
+  dateEndsGte: z.string().optional(),
+  dateEndsLte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    companyId: "company_id",
+    fullNameLike: "full_name_like",
+    companyNameLike: "company_name_like",
+    firstNameLike: "first_name_like",
+    lastNameLike: "last_name_like",
+    emailLike: "email_like",
+    credentialingSubscriptionStatus: "credentialing_subscription_status",
+    scrubsSubscriptionStatus: "scrubs_subscription_status",
+    vendorTypeLike: "vendor_type_like",
+    vendorFieldValueLike: "vendor_field_value_like",
+    dateScannedGte: "date_scanned_gte",
+    dateScannedLte: "date_scanned_lte",
+    dateEndsGte: "date_ends_gte",
+    dateEndsLte: "date_ends_lte",
+  });
+});
+
+export function listVendorsRequestToJSON(
+  listVendorsRequest: ListVendorsRequest,
+): string {
+  return JSON.stringify(
+    ListVendorsRequest$outboundSchema.parse(listVendorsRequest),
+  );
+}
+
+/** @internal */
+export const ListVendorsListVendorsOk$inboundSchema: z.ZodType<
+  ListVendorsListVendorsOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(components.Vendor$inboundSchema),
+});
+
+export function listVendorsListVendorsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorsListVendorsOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorsListVendorsOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorsListVendorsOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListVendorsResponse$inboundSchema: z.ZodType<
+  ListVendorsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListVendorsListVendorsOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listVendorsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorsResponse' from JSON`,
+  );
+}

package/src/models/operations/listvendorscans.ts

@@ -0,0 +1,206 @@
+/*
+ * 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 { 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;
+  /**
+   * Filter by individual full name (case-insensitive, partial match).
+   */
+  fullNameLike?: string | undefined;
+  /**
+   * Filter scans on or after this date. Format: YYYY-MM-DD.
+   */
+  dateScannedGte?: string | undefined;
+  /**
+   * Filter scans on or before this date. Format: YYYY-MM-DD.
+   */
+  dateScannedLte?: string | undefined;
+  /**
+   * Filter by scan result. `true` for successful scans, `false` for failed.
+   */
+  result?: boolean | undefined;
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | 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;
+  full_name_like?: string | undefined;
+  date_scanned_gte?: string | undefined;
+  date_scanned_lte?: string | undefined;
+  result?: boolean | undefined;
+  expand?: Array<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(),
+  fullNameLike: z.string().optional(),
+  dateScannedGte: z.string().optional(),
+  dateScannedLte: z.string().optional(),
+  result: z.boolean().optional(),
+  expand: z.array(components.Expand$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",
+    fullNameLike: "full_name_like",
+    dateScannedGte: "date_scanned_gte",
+    dateScannedLte: "date_scanned_lte",
+  });
+});
+
+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

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

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

@@ -27,7 +27,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/lookupcompanies.ts

@@ -0,0 +1,126 @@
+/*
+ * 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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type LookupCompaniesRequest = {
+  /**
+   * 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 lightweight company lookup items to return per page.
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * A partial string to search in the object name. Do not include any wildcard characters. Searches are not case-sensitive by default.
+   */
+  nameLike?: string | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type LookupCompaniesLookupCompaniesOK = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.CompanyLookup>;
+};
+
+export type LookupCompaniesResponse = {
+  result: LookupCompaniesLookupCompaniesOK;
+};
+
+/** @internal */
+export type LookupCompaniesRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page: number;
+  name_like?: string | undefined;
+};
+
+/** @internal */
+export const LookupCompaniesRequest$outboundSchema: z.ZodType<
+  LookupCompaniesRequest$Outbound,
+  z.ZodTypeDef,
+  LookupCompaniesRequest
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().default(25),
+  nameLike: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    nameLike: "name_like",
+  });
+});
+
+export function lookupCompaniesRequestToJSON(
+  lookupCompaniesRequest: LookupCompaniesRequest,
+): string {
+  return JSON.stringify(
+    LookupCompaniesRequest$outboundSchema.parse(lookupCompaniesRequest),
+  );
+}
+
+/** @internal */
+export const LookupCompaniesLookupCompaniesOK$inboundSchema: z.ZodType<
+  LookupCompaniesLookupCompaniesOK,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(components.CompanyLookup$inboundSchema),
+});
+
+export function lookupCompaniesLookupCompaniesOKFromJSON(
+  jsonString: string,
+): SafeParseResult<LookupCompaniesLookupCompaniesOK, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LookupCompaniesLookupCompaniesOK$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LookupCompaniesLookupCompaniesOK' from JSON`,
+  );
+}
+
+/** @internal */
+export const LookupCompaniesResponse$inboundSchema: z.ZodType<
+  LookupCompaniesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => LookupCompaniesLookupCompaniesOK$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function lookupCompaniesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<LookupCompaniesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LookupCompaniesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LookupCompaniesResponse' from JSON`,
+  );
+}

package/src/models/operations/postauthenticate.ts

@@ -22,13 +22,15 @@ export type PostAuthenticateRequestBody =
 export type PostAuthenticateResponseBody =
   | components.MfaRequiredResponse
   | components.SamlLoginRequiredResponse
-  | components.PasswordRequiredResponse;
+  | components.PasswordRequiredResponse
+  | components.PasswordNotSetResponse;
 
 export type PostAuthenticateResponse =
   | components.User
   | components.MfaRequiredResponse
   | components.SamlLoginRequiredResponse
-  | components.PasswordRequiredResponse;
+  | components.PasswordRequiredResponse
+  | components.PasswordNotSetResponse;
 
 /** @internal */
 export type PostAuthenticateRequestBody$Outbound =
@@ -64,6 +66,7 @@ export const PostAuthenticateResponseBody$inboundSchema: z.ZodType<
   components.MfaRequiredResponse$inboundSchema,
   components.SamlLoginRequiredResponse$inboundSchema,
   components.PasswordRequiredResponse$inboundSchema,
+  components.PasswordNotSetResponse$inboundSchema,
 ]);
 
 export function postAuthenticateResponseBodyFromJSON(
@@ -87,6 +90,7 @@ export const PostAuthenticateResponse$inboundSchema: z.ZodType<
     components.MfaRequiredResponse$inboundSchema,
     components.SamlLoginRequiredResponse$inboundSchema,
     components.PasswordRequiredResponse$inboundSchema,
+    components.PasswordNotSetResponse$inboundSchema,
   ]),
 ]);
 

package/src/models/operations/purchasescrubcredits.ts

@@ -16,7 +16,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;