@greensecurity/javascript-sdk 0.44.0-beta.4 → 0.44.0-beta.40

package/src/models/operations/exportvendorscans.ts

@@ -0,0 +1,163 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import * as components from "../components/index.js";
+
+/**
+ * Sort field used by the exporter when ordering rows in the generated CSV. One of:
+ *
+ * @remarks
+ * `full_name`, `date_scanned`, `result`, `scan_type`. Defaults to `date_scanned`.
+ */
+export const ExportVendorScansQueryParamSort = {
+  FullName: "full_name",
+  DateScanned: "date_scanned",
+  Result: "result",
+  ScanType: "scan_type",
+} as const;
+/**
+ * Sort field used by the exporter when ordering rows in the generated CSV. One of:
+ *
+ * @remarks
+ * `full_name`, `date_scanned`, `result`, `scan_type`. Defaults to `date_scanned`.
+ */
+export type ExportVendorScansQueryParamSort = ClosedEnum<
+  typeof ExportVendorScansQueryParamSort
+>;
+
+/**
+ * Filter by scan type. One of: `in`, `out`, `spot_check`.
+ */
+export const QueryParamScanType = {
+  In: "in",
+  Out: "out",
+  SpotCheck: "spot_check",
+} as const;
+/**
+ * Filter by scan type. One of: `in`, `out`, `spot_check`.
+ */
+export type QueryParamScanType = ClosedEnum<typeof QueryParamScanType>;
+
+export type ExportVendorScansRequest = {
+  /**
+   * Sort field used by the exporter when ordering rows in the generated CSV. One of:
+   *
+   * @remarks
+   * `full_name`, `date_scanned`, `result`, `scan_type`. Defaults to `date_scanned`.
+   */
+  sort?: ExportVendorScansQueryParamSort | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * Page size used by the exporter while paginating results server-side. Does not affect the size of the CSV (all matching rows are included).
+   */
+  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?: QueryParamScanType | 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;
+};
+
+/** @internal */
+export const ExportVendorScansQueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof ExportVendorScansQueryParamSort
+> = z.nativeEnum(ExportVendorScansQueryParamSort);
+
+/** @internal */
+export const QueryParamScanType$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamScanType
+> = z.nativeEnum(QueryParamScanType);
+
+/** @internal */
+export type ExportVendorScansRequest$Outbound = {
+  sort?: string | undefined;
+  desc?: components.Desc$Outbound | 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;
+};
+
+/** @internal */
+export const ExportVendorScansRequest$outboundSchema: z.ZodType<
+  ExportVendorScansRequest$Outbound,
+  z.ZodTypeDef,
+  ExportVendorScansRequest
+> = z.object({
+  sort: ExportVendorScansQueryParamSort$outboundSchema.optional(),
+  desc: components.Desc$outboundSchema.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: QueryParamScanType$outboundSchema.optional(),
+  fullNameLike: z.string().optional(),
+  dateScannedGte: z.string().optional(),
+  dateScannedLte: z.string().optional(),
+  result: z.boolean().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 exportVendorScansRequestToJSON(
+  exportVendorScansRequest: ExportVendorScansRequest,
+): string {
+  return JSON.stringify(
+    ExportVendorScansRequest$outboundSchema.parse(exportVendorScansRequest),
+  );
+}

package/src/models/operations/getcompanytargetfacilitiesexportstatus.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 types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetCompanyTargetFacilitiesExportStatusRequest = {
+  /**
+   * The company whose export is being polled.
+   */
+  companyId: number;
+  /**
+   * Export status id returned by the export endpoint (e.g. `ctf_export_42`).
+   */
+  id: string;
+};
+
+/**
+ * Export status
+ */
+export type GetCompanyTargetFacilitiesExportStatusResponseBody = {
+  /**
+   * When true, the export is ready for download.
+   */
+  ready: boolean;
+  /**
+   * The export job identifier.
+   */
+  statusId: string;
+  /**
+   * URL to download the CSV (present only when `ready` is true).
+   */
+  downloadUrl?: string | undefined;
+  /**
+   * When the export job completed.
+   */
+  finishedAt?: string | undefined;
+  /**
+   * When the export job started.
+   */
+  startedAt?: string | undefined;
+  /**
+   * Timestamp of the last progress heartbeat from the background job. Updated on each pagination loop while the job is running; on completion or failure it equals `finished_at`.
+   */
+  heartbeat?: string | undefined;
+  /**
+   * Error message if the export failed.
+   */
+  error?: string | undefined;
+};
+
+/** @internal */
+export type GetCompanyTargetFacilitiesExportStatusRequest$Outbound = {
+  company_id: number;
+  id: string;
+};
+
+/** @internal */
+export const GetCompanyTargetFacilitiesExportStatusRequest$outboundSchema:
+  z.ZodType<
+    GetCompanyTargetFacilitiesExportStatusRequest$Outbound,
+    z.ZodTypeDef,
+    GetCompanyTargetFacilitiesExportStatusRequest
+  > = z.object({
+    companyId: z.number().int(),
+    id: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      companyId: "company_id",
+    });
+  });
+
+export function getCompanyTargetFacilitiesExportStatusRequestToJSON(
+  getCompanyTargetFacilitiesExportStatusRequest:
+    GetCompanyTargetFacilitiesExportStatusRequest,
+): string {
+  return JSON.stringify(
+    GetCompanyTargetFacilitiesExportStatusRequest$outboundSchema.parse(
+      getCompanyTargetFacilitiesExportStatusRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetCompanyTargetFacilitiesExportStatusResponseBody$inboundSchema:
+  z.ZodType<
+    GetCompanyTargetFacilitiesExportStatusResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    ready: types.boolean(),
+    status_id: types.string(),
+    download_url: types.optional(types.string()),
+    finished_at: types.optional(types.string()),
+    started_at: types.optional(types.string()),
+    heartbeat: types.optional(types.string()),
+    error: types.optional(types.string()),
+  }).transform((v) => {
+    return remap$(v, {
+      "status_id": "statusId",
+      "download_url": "downloadUrl",
+      "finished_at": "finishedAt",
+      "started_at": "startedAt",
+    });
+  });
+
+export function getCompanyTargetFacilitiesExportStatusResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetCompanyTargetFacilitiesExportStatusResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCompanyTargetFacilitiesExportStatusResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetCompanyTargetFacilitiesExportStatusResponseBody' from JSON`,
+  );
+}

package/src/models/operations/getfacilityvendorsexportstatus.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type GetFacilityVendorsExportStatusRequest = {
+  /**
+   * The facility whose export is being polled.
+   */
+  id: number;
+  /**
+   * Export status id returned by the export endpoint (e.g. `fv_export_42`).
+   */
+  exportId: string;
+};
+
+/** @internal */
+export type GetFacilityVendorsExportStatusRequest$Outbound = {
+  id: number;
+  export_id: string;
+};
+
+/** @internal */
+export const GetFacilityVendorsExportStatusRequest$outboundSchema: z.ZodType<
+  GetFacilityVendorsExportStatusRequest$Outbound,
+  z.ZodTypeDef,
+  GetFacilityVendorsExportStatusRequest
+> = z.object({
+  id: z.number().int(),
+  exportId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    exportId: "export_id",
+  });
+});
+
+export function getFacilityVendorsExportStatusRequestToJSON(
+  getFacilityVendorsExportStatusRequest: GetFacilityVendorsExportStatusRequest,
+): string {
+  return JSON.stringify(
+    GetFacilityVendorsExportStatusRequest$outboundSchema.parse(
+      getFacilityVendorsExportStatusRequest,
+    ),
+  );
+}

package/src/models/operations/getlinkedusers.ts

@@ -11,9 +11,14 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetLinkedUsersRequest = {
   /**
-   * The ID of the user to fetch linked users for. Required for API users.
+   * The user to fetch linked users for. Pass `me` for the authenticated user
+   *
+   * @remarks
+   * (allowed for any user type), or a positive numeric user ID. A numeric ID is
+   * only honored for API users with an active app activation for that user;
+   * non-API users must pass `me`.
    */
-  userId?: number | undefined;
+  userId: string;
 };
 
 export type LinkedUsers = {
@@ -33,7 +38,7 @@ export type GetLinkedUsersGetLinkedUsersOk = {
 
 /** @internal */
 export type GetLinkedUsersRequest$Outbound = {
-  user_id?: number | undefined;
+  user_id: string;
 };
 
 /** @internal */
@@ -42,7 +47,7 @@ export const GetLinkedUsersRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetLinkedUsersRequest
 > = z.object({
-  userId: z.number().int().optional(),
+  userId: z.string(),
 }).transform((v) => {
   return remap$(v, {
     userId: "user_id",

package/src/models/operations/getnextunansweredscreeningquestion.ts

@@ -21,6 +21,10 @@ export type GetNextUnansweredScreeningQuestionRequest = {
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
+  /**
+   * When provided, filters questions to those belonging to the specified facility. The facility must be targeted by the vendor.
+   */
+  facilityId?: number | 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.
    */
@@ -34,12 +38,17 @@ export type GetNextUnansweredScreeningQuestionGetNextUnansweredScreeningQuestion
   {
     screeningQuestion: components.ScreeningQuestion | null;
     screeningResponse: components.ScreeningResponse | null;
+    /**
+     * Name of the facility the questions are scoped to. Null when facility_id query param is omitted.
+     */
+    facilityName: string | null;
     success: boolean;
   };
 
 /** @internal */
 export type GetNextUnansweredScreeningQuestionRequest$Outbound = {
   vendor_id_or_me: string;
+  facility_id?: number | undefined;
   expand?: Array<string> | undefined;
 };
 
@@ -51,10 +60,12 @@ export const GetNextUnansweredScreeningQuestionRequest$outboundSchema:
     GetNextUnansweredScreeningQuestionRequest
   > = z.object({
     vendorIdOrMe: z.string(),
+    facilityId: z.number().int().optional(),
     expand: z.array(components.Expand$outboundSchema).optional(),
   }).transform((v) => {
     return remap$(v, {
       vendorIdOrMe: "vendor_id_or_me",
+      facilityId: "facility_id",
     });
   });
 
@@ -82,11 +93,13 @@ export const GetNextUnansweredScreeningQuestionGetNextUnansweredScreeningQuestio
     screening_response: types.nullable(
       components.ScreeningResponse$inboundSchema,
     ),
+    facility_name: types.nullable(types.string()),
     success: types.boolean(),
   }).transform((v) => {
     return remap$(v, {
       "screening_question": "screeningQuestion",
       "screening_response": "screeningResponse",
+      "facility_name": "facilityName",
     });
   });
 

package/src/models/operations/getvendorpaymentresponsibility.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetVendorPaymentResponsibilityRequest = {
+  /**
+   * ID of the vendor rep.
+   */
+  vendorId: number;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type GetVendorPaymentResponsibilityGetVendorPaymentResponsibilityOk = {
+  /**
+   * Records which party (vendor or company manager) is responsible for each
+   *
+   * @remarks
+   * payment category for a given vendor–company relationship. A `null`
+   * `_user_id` field means responsibility defaults to the vendor.
+   */
+  paymentResponsibility?:
+    | components.VendorPaymentResponsibilityAssignments
+    | undefined;
+};
+
+/** @internal */
+export type GetVendorPaymentResponsibilityRequest$Outbound = {
+  vendor_id: number;
+};
+
+/** @internal */
+export const GetVendorPaymentResponsibilityRequest$outboundSchema: z.ZodType<
+  GetVendorPaymentResponsibilityRequest$Outbound,
+  z.ZodTypeDef,
+  GetVendorPaymentResponsibilityRequest
+> = z.object({
+  vendorId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    vendorId: "vendor_id",
+  });
+});
+
+export function getVendorPaymentResponsibilityRequestToJSON(
+  getVendorPaymentResponsibilityRequest: GetVendorPaymentResponsibilityRequest,
+): string {
+  return JSON.stringify(
+    GetVendorPaymentResponsibilityRequest$outboundSchema.parse(
+      getVendorPaymentResponsibilityRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetVendorPaymentResponsibilityGetVendorPaymentResponsibilityOk$inboundSchema:
+  z.ZodType<
+    GetVendorPaymentResponsibilityGetVendorPaymentResponsibilityOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    payment_responsibility: types.optional(
+      components.VendorPaymentResponsibilityAssignments$inboundSchema,
+    ),
+  }).transform((v) => {
+    return remap$(v, {
+      "payment_responsibility": "paymentResponsibility",
+    });
+  });
+
+export function getVendorPaymentResponsibilityGetVendorPaymentResponsibilityOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetVendorPaymentResponsibilityGetVendorPaymentResponsibilityOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetVendorPaymentResponsibilityGetVendorPaymentResponsibilityOk$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'GetVendorPaymentResponsibilityGetVendorPaymentResponsibilityOk' from JSON`,
+  );
+}

package/src/models/operations/getvendorscansexportstatus.ts

@@ -0,0 +1,108 @@
+/*
+ * 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 GetVendorScansExportStatusRequest = {
+  /**
+   * Export status id returned by the export vendor scans endpoint.
+   */
+  id: string;
+};
+
+/**
+ * Export status
+ */
+export type GetVendorScansExportStatusResponseBody = {
+  /**
+   * When true, the export is ready for download.
+   */
+  ready: boolean;
+  /**
+   * The export job identifier.
+   */
+  statusId: string;
+  /**
+   * URL to download the CSV (present only when `ready` is true).
+   */
+  downloadUrl?: string | undefined;
+  /**
+   * When the export job completed.
+   */
+  finishedAt?: string | undefined;
+  /**
+   * When the export job started.
+   */
+  startedAt?: string | undefined;
+  /**
+   * Timestamp of the last progress heartbeat from the background job. Updated on each pagination loop while the job is running; on completion or failure it equals `finished_at`.
+   */
+  heartbeat?: string | undefined;
+  /**
+   * Error message if the export failed.
+   */
+  error?: string | undefined;
+};
+
+/** @internal */
+export type GetVendorScansExportStatusRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetVendorScansExportStatusRequest$outboundSchema: z.ZodType<
+  GetVendorScansExportStatusRequest$Outbound,
+  z.ZodTypeDef,
+  GetVendorScansExportStatusRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getVendorScansExportStatusRequestToJSON(
+  getVendorScansExportStatusRequest: GetVendorScansExportStatusRequest,
+): string {
+  return JSON.stringify(
+    GetVendorScansExportStatusRequest$outboundSchema.parse(
+      getVendorScansExportStatusRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetVendorScansExportStatusResponseBody$inboundSchema: z.ZodType<
+  GetVendorScansExportStatusResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ready: types.boolean(),
+  status_id: types.string(),
+  download_url: types.optional(types.string()),
+  finished_at: types.optional(types.string()),
+  started_at: types.optional(types.string()),
+  heartbeat: types.optional(types.string()),
+  error: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "status_id": "statusId",
+    "download_url": "downloadUrl",
+    "finished_at": "finishedAt",
+    "started_at": "startedAt",
+  });
+});
+
+export function getVendorScansExportStatusResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetVendorScansExportStatusResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetVendorScansExportStatusResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetVendorScansExportStatusResponseBody' from JSON`,
+  );
+}