@greensecurity/javascript-sdk 0.43.1-beta.1 → 0.43.1-beta.102

package/src/models/components/subscription.ts

@@ -27,7 +27,7 @@ export type Subscription = {
   dateEnds?: string | null | undefined;
   status?: string | null | undefined;
   locked?: boolean | null | undefined;
-  variantTitle?: string | null | undefined;
+  variantTitle?: string | undefined;
   /**
    * Reduced list of attributes of the Invoice line item record
    */
@@ -52,7 +52,7 @@ export const Subscription$inboundSchema: z.ZodType<
   date_ends: z.nullable(types.string()).optional(),
   status: z.nullable(types.string()).optional(),
   locked: z.nullable(types.boolean()).optional(),
-  variant_title: z.nullable(types.string()).optional(),
+  variant_title: types.optional(types.string()),
   current_line_item: z.nullable(InvoiceItem$inboundSchema).optional(),
   next_line_item: z.nullable(InvoiceItem$inboundSchema).optional(),
   current_financial_status: z.nullable(FinancialStatus$inboundSchema)

package/src/models/components/supervisor.ts

@@ -13,7 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type Supervisor = {
   name?: string | null | undefined;
-  email?: any | undefined;
+  email?: string | null | undefined;
   phone?: string | null | undefined;
 };
 
@@ -24,13 +24,13 @@ export const Supervisor$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.nullable(types.string()).optional(),
-  email: types.optional(z.any()),
+  email: z.nullable(types.string()).optional(),
   phone: z.nullable(types.string()).optional(),
 });
 /** @internal */
 export type Supervisor$Outbound = {
   name?: string | null | undefined;
-  email?: any | undefined;
+  email?: string | null | undefined;
   phone?: string | null | undefined;
 };
 
@@ -41,7 +41,7 @@ export const Supervisor$outboundSchema: z.ZodType<
   Supervisor
 > = z.object({
   name: z.nullable(z.string()).optional(),
-  email: z.any().optional(),
+  email: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
 });
 

package/src/models/components/user.ts

@@ -95,7 +95,7 @@ export type UserToken = {
   /**
    * A `permanent` user token can be used to access any API endpoint as the logged in user. A `one time` token is used to authenticate the user once.
    */
-  tokenType?: TokenType | undefined;
+  tokenType: TokenType;
 };
 
 export type InventoryManager = {};

package/src/models/components/vendor.ts

@@ -32,10 +32,15 @@ import {
 } from "./vendorjobtitle.js";
 import { VendorType, VendorType$inboundSchema } from "./vendortype.js";
 
+export type Badge = {
+  badgeType?: string | undefined;
+  requiredBadgeType?: string | null | undefined;
+};
+
 export type One = {
   id?: number | undefined;
   firstName?: string | null | undefined;
-  lastName?: any | undefined;
+  lastName?: string | null | undefined;
   email?: string | null | undefined;
   phone?: string | null | undefined;
   mobilePhone?: string | null | undefined;
@@ -119,6 +124,7 @@ export type PendingInvoice = Invoice | number;
  */
 export type Vendor = {
   id?: number | undefined;
+  badge?: Badge | null | undefined;
   emailRecepient?: string | null | undefined;
   sendWeeklySummaryEmail?: boolean | null | undefined;
   title?: string | null | undefined;
@@ -183,12 +189,34 @@ export type Vendor = {
   targetFacilitiesUpdated?: string | null | undefined;
 };
 
+/** @internal */
+export const Badge$inboundSchema: z.ZodType<Badge, z.ZodTypeDef, unknown> = z
+  .object({
+    badge_type: types.optional(types.string()),
+    required_badge_type: z.nullable(types.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "badge_type": "badgeType",
+      "required_badge_type": "requiredBadgeType",
+    });
+  });
+
+export function badgeFromJSON(
+  jsonString: string,
+): SafeParseResult<Badge, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Badge$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Badge' from JSON`,
+  );
+}
+
 /** @internal */
 export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
   .object({
     id: types.optional(types.number()),
     first_name: z.nullable(types.string()).optional(),
-    last_name: types.optional(z.any()),
+    last_name: z.nullable(types.string()).optional(),
     email: z.nullable(types.string()).optional(),
     phone: z.nullable(types.string()).optional(),
     mobile_phone: z.nullable(types.string()).optional(),
@@ -492,6 +520,7 @@ export function pendingInvoiceFromJSON(
 export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
   .object({
     id: types.optional(types.number()),
+    badge: z.nullable(z.lazy(() => Badge$inboundSchema)).optional(),
     email_recepient: z.nullable(types.string()).optional(),
     send_weekly_summary_email: z.nullable(types.boolean()).optional(),
     title: z.nullable(types.string()).optional(),

package/src/models/components/vendorcredentialsummary.ts

@@ -75,6 +75,7 @@ export type VendorCredentialSummary = {
   jsonData?: string | null | undefined;
   filename?: string | null | undefined;
   alternateId?: number | null | undefined;
+  appliesToCompany?: boolean | null | undefined;
   credential?: Credential | number | null | undefined;
   vendor?: Vendor | number | null | undefined;
   invoice?: Invoice | number | null | undefined;
@@ -257,6 +258,7 @@ export const VendorCredentialSummary$inboundSchema: z.ZodType<
   json_data: z.nullable(types.string()).optional(),
   filename: z.nullable(types.string()).optional(),
   alternate_id: z.nullable(types.number()).optional(),
+  applies_to_company: z.nullable(types.boolean()).optional(),
   credential: z.nullable(smartUnion([Credential$inboundSchema, types.number()]))
     .optional(),
   vendor: z.nullable(smartUnion([Vendor$inboundSchema, types.number()]))
@@ -301,6 +303,7 @@ export const VendorCredentialSummary$inboundSchema: z.ZodType<
     "date_valid": "dateValid",
     "json_data": "jsonData",
     "alternate_id": "alternateId",
+    "applies_to_company": "appliesToCompany",
     "vendor_credential_files": "vendorCredentialFiles",
     "latest_vendor_credential_id": "latestVendorCredentialId",
     "previously_approved": "previouslyApproved",

package/src/models/components/{vendoradditionalfacilityfields.ts → vendorcustomfields.ts}

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type VendorAdditionalFacilityFields = {
+export type VendorCustomFields = {
   id?: number | undefined;
   system?: string | null | undefined;
   facility?: string | null | undefined;
@@ -17,8 +17,8 @@ export type VendorAdditionalFacilityFields = {
 };
 
 /** @internal */
-export const VendorAdditionalFacilityFields$inboundSchema: z.ZodType<
-  VendorAdditionalFacilityFields,
+export const VendorCustomFields$inboundSchema: z.ZodType<
+  VendorCustomFields,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -29,12 +29,12 @@ export const VendorAdditionalFacilityFields$inboundSchema: z.ZodType<
   value: z.nullable(types.string()).optional(),
 });
 
-export function vendorAdditionalFacilityFieldsFromJSON(
+export function vendorCustomFieldsFromJSON(
   jsonString: string,
-): SafeParseResult<VendorAdditionalFacilityFields, SDKValidationError> {
+): SafeParseResult<VendorCustomFields, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => VendorAdditionalFacilityFields$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'VendorAdditionalFacilityFields' from JSON`,
+    (x) => VendorCustomFields$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorCustomFields' from JSON`,
   );
 }

package/src/models/components/vendorscan.ts

@@ -31,6 +31,9 @@ export type VendorScan = {
   scanInVendorScanId?: number | null | undefined;
   scanOutVendorScanId?: number | null | undefined;
   autoScanOut?: boolean | undefined;
+  finishedScreeningQuestions?: boolean | undefined;
+  requiresScreeningQuestions?: boolean | undefined;
+  recheck?: boolean | undefined;
 };
 
 /** @internal */
@@ -71,6 +74,9 @@ export const VendorScan$inboundSchema: z.ZodType<
   scan_in_vendor_scan_id: z.nullable(types.number()).optional(),
   scan_out_vendor_scan_id: z.nullable(types.number()).optional(),
   auto_scan_out: types.optional(types.boolean()),
+  finished_screening_questions: types.optional(types.boolean()),
+  requires_screening_questions: types.optional(types.boolean()),
+  recheck: types.optional(types.boolean()),
 }).transform((v) => {
   return remap$(v, {
     "qr_code": "qrCode",
@@ -81,6 +87,8 @@ export const VendorScan$inboundSchema: z.ZodType<
     "scan_in_vendor_scan_id": "scanInVendorScanId",
     "scan_out_vendor_scan_id": "scanOutVendorScanId",
     "auto_scan_out": "autoScanOut",
+    "finished_screening_questions": "finishedScreeningQuestions",
+    "requires_screening_questions": "requiresScreeningQuestions",
   });
 });
 

package/src/models/components/vendorscanscreeninganswer.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const AnswerType = {
+  Preset: "preset",
+  Date: "date",
+  ShortAnswer: "short answer",
+  LongAnswer: "long answer",
+} as const;
+export type AnswerType = OpenEnum<typeof AnswerType>;
+
+/**
+ * Reduced set of attributes for a screening answer, used in vendor_scan context. Matches the fields returned by ScreeningAnswer#api_json when context: :vendor_scan is applied.
+ *
+ * @remarks
+ */
+export type VendorScanScreeningAnswer = {
+  id: number;
+  answer?: string | null | undefined;
+  answerType?: AnswerType | null | undefined;
+  priority?: number | null | undefined;
+  showConfirmation?: boolean | undefined;
+  confirmationText?: string | null | undefined;
+  answerTitle?: string | null | undefined;
+  allowEmptyAnswer?: boolean | undefined;
+  emptyAnswerErrorMessage?: string | null | undefined;
+};
+
+/** @internal */
+export const AnswerType$inboundSchema: z.ZodType<
+  AnswerType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AnswerType);
+
+/** @internal */
+export const VendorScanScreeningAnswer$inboundSchema: z.ZodType<
+  VendorScanScreeningAnswer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  answer: z.nullable(types.string()).optional(),
+  answer_type: z.nullable(AnswerType$inboundSchema).optional(),
+  priority: z.nullable(types.number()).optional(),
+  show_confirmation: types.optional(types.boolean()),
+  confirmation_text: z.nullable(types.string()).optional(),
+  answer_title: z.nullable(types.string()).optional(),
+  allow_empty_answer: types.optional(types.boolean()),
+  empty_answer_error_message: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "answer_type": "answerType",
+    "show_confirmation": "showConfirmation",
+    "confirmation_text": "confirmationText",
+    "answer_title": "answerTitle",
+    "allow_empty_answer": "allowEmptyAnswer",
+    "empty_answer_error_message": "emptyAnswerErrorMessage",
+  });
+});
+
+export function vendorScanScreeningAnswerFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorScanScreeningAnswer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorScanScreeningAnswer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorScanScreeningAnswer' from JSON`,
+  );
+}

package/src/models/components/vendorscanscreeningquestion.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  VendorScanScreeningAnswer,
+  VendorScanScreeningAnswer$inboundSchema,
+} from "./vendorscanscreeninganswer.js";
+
+/**
+ * The display format for presenting this question.
+ */
+export const PresetDisplayAs = {
+  FloatingButtons: "floating buttons",
+  LineButtons: "line buttons",
+  Radio: "radio",
+  Select: "select",
+  Checkbox: "checkbox",
+  Checkbox2Column: "checkbox (2-column)",
+} as const;
+/**
+ * The display format for presenting this question.
+ */
+export type PresetDisplayAs = OpenEnum<typeof PresetDisplayAs>;
+
+/**
+ * Reduced set of attributes for a screening question, used in vendor_scan context. Contains only the fields required for rendering the next question in the vendor screening workflow.
+ *
+ * @remarks
+ */
+export type VendorScanScreeningQuestion = {
+  /**
+   * The unique ID of the screening question.
+   */
+  id: number;
+  /**
+   * The text of the screening question.
+   */
+  question?: string | null | undefined;
+  /**
+   * The display format for presenting this question.
+   */
+  presetDisplayAs?: PresetDisplayAs | null | undefined;
+  /**
+   * The ID of the screening answer selected by default, if any.
+   *
+   * @remarks
+   */
+  screeningAnswerId?: number | null | undefined;
+  /**
+   * The list of possible answers for this question.
+   */
+  screeningAnswers?: Array<VendorScanScreeningAnswer> | undefined;
+};
+
+/** @internal */
+export const PresetDisplayAs$inboundSchema: z.ZodType<
+  PresetDisplayAs,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PresetDisplayAs);
+
+/** @internal */
+export const VendorScanScreeningQuestion$inboundSchema: z.ZodType<
+  VendorScanScreeningQuestion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  question: z.nullable(types.string()).optional(),
+  preset_display_as: z.nullable(PresetDisplayAs$inboundSchema).optional(),
+  screening_answer_id: z.nullable(types.number()).optional(),
+  screening_answers: types.optional(
+    z.array(VendorScanScreeningAnswer$inboundSchema),
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "preset_display_as": "presetDisplayAs",
+    "screening_answer_id": "screeningAnswerId",
+    "screening_answers": "screeningAnswers",
+  });
+});
+
+export function vendorScanScreeningQuestionFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorScanScreeningQuestion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorScanScreeningQuestion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorScanScreeningQuestion' from JSON`,
+  );
+}

package/src/models/errors/apierrorresponse.ts

@@ -15,7 +15,7 @@ import { GreenSecurityError } from "./greensecurityerror.js";
  */
 export type ApiErrorResponseData = {
   error: string;
-  success: boolean;
+  success?: boolean | undefined;
   code?: number | null | undefined;
 };
 
@@ -28,7 +28,7 @@ export type ApiErrorResponseData = {
  */
 export class ApiErrorResponse extends GreenSecurityError {
   error: string;
-  success: boolean;
+  success?: boolean | undefined;
   code?: number | null | undefined;
 
   /** The original data that was passed to this error instance. */
@@ -44,7 +44,7 @@ export class ApiErrorResponse extends GreenSecurityError {
     super(message, httpMeta);
     this.data$ = err;
     this.error = err.error;
-    this.success = err.success;
+    if (err.success != null) this.success = err.success;
     if (err.code != null) this.code = err.code;
 
     this.name = "ApiErrorResponse";
@@ -58,7 +58,7 @@ export const ApiErrorResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: types.string(),
-  success: types.boolean(),
+  success: types.optional(types.boolean()),
   code: z.nullable(types.number()).optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),

package/src/models/operations/downloadinvoicesexport.ts

@@ -0,0 +1,140 @@
+/*
+ * 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 { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DownloadInvoicesExportRequest = {
+  /**
+   * Export id returned by the export invoice endpoint.
+   */
+  id: string;
+};
+
+/**
+ * Export is still being generated
+ */
+export type DownloadInvoicesExportResponseBody = {
+  /**
+   * Current status of the export job
+   */
+  status?: string | undefined;
+  /**
+   * Human-readable message about the export status
+   */
+  message?: string | undefined;
+};
+
+export type DownloadInvoicesExportResponseResult =
+  | ReadableStream<Uint8Array>
+  | DownloadInvoicesExportResponseBody;
+
+export type DownloadInvoicesExportResponse = {
+  headers: { [k: string]: Array<string> };
+  result?:
+    | ReadableStream<Uint8Array>
+    | DownloadInvoicesExportResponseBody
+    | undefined;
+};
+
+/** @internal */
+export type DownloadInvoicesExportRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DownloadInvoicesExportRequest$outboundSchema: z.ZodType<
+  DownloadInvoicesExportRequest$Outbound,
+  z.ZodTypeDef,
+  DownloadInvoicesExportRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function downloadInvoicesExportRequestToJSON(
+  downloadInvoicesExportRequest: DownloadInvoicesExportRequest,
+): string {
+  return JSON.stringify(
+    DownloadInvoicesExportRequest$outboundSchema.parse(
+      downloadInvoicesExportRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const DownloadInvoicesExportResponseBody$inboundSchema: z.ZodType<
+  DownloadInvoicesExportResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: types.optional(types.string()),
+  message: types.optional(types.string()),
+});
+
+export function downloadInvoicesExportResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<DownloadInvoicesExportResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadInvoicesExportResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DownloadInvoicesExportResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const DownloadInvoicesExportResponseResult$inboundSchema: z.ZodType<
+  DownloadInvoicesExportResponseResult,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([
+  z.instanceof(ReadableStream<Uint8Array>),
+  z.lazy(() => DownloadInvoicesExportResponseBody$inboundSchema),
+]);
+
+export function downloadInvoicesExportResponseResultFromJSON(
+  jsonString: string,
+): SafeParseResult<DownloadInvoicesExportResponseResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadInvoicesExportResponseResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DownloadInvoicesExportResponseResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const DownloadInvoicesExportResponse$inboundSchema: z.ZodType<
+  DownloadInvoicesExportResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: types.optional(
+    smartUnion([
+      z.instanceof(ReadableStream<Uint8Array>),
+      z.lazy(() => DownloadInvoicesExportResponseBody$inboundSchema),
+    ]),
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function downloadInvoicesExportResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DownloadInvoicesExportResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DownloadInvoicesExportResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DownloadInvoicesExportResponse' from JSON`,
+  );
+}

package/src/models/operations/getcompany.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type GetCompanyRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  /**
+   * 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;
+};
+
+/** @internal */
+export type GetCompanyRequest$Outbound = {
+  id: number;
+  expand?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GetCompanyRequest$outboundSchema: z.ZodType<
+  GetCompanyRequest$Outbound,
+  z.ZodTypeDef,
+  GetCompanyRequest
+> = z.object({
+  id: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+});
+
+export function getCompanyRequestToJSON(
+  getCompanyRequest: GetCompanyRequest,
+): string {
+  return JSON.stringify(
+    GetCompanyRequest$outboundSchema.parse(getCompanyRequest),
+  );
+}

package/src/models/operations/getfacility.ts

@@ -3,17 +3,23 @@
  */
 
 import * as z from "zod/v3";
+import * as components from "../components/index.js";
 
 export type GetFacilityRequest = {
   /**
    * The identifier of the object
    */
   id: number;
+  /**
+   * 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;
 };
 
 /** @internal */
 export type GetFacilityRequest$Outbound = {
   id: number;
+  expand?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -23,6 +29,7 @@ export const GetFacilityRequest$outboundSchema: z.ZodType<
   GetFacilityRequest
 > = z.object({
   id: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
 });
 
 export function getFacilityRequestToJSON(