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

package/src/models/components/companytargetfacility.ts

@@ -35,9 +35,9 @@ export type IndividualCounts = {
  */
 export type CompanyTargetFacility = {
   /**
-   * CompanyTargetFacility row ID.
+   * CompanyTargetFacility row ID. Null when returned via `include_potential_targets=true` for a facility not yet targeted by the company.
    */
-  id: number;
+  id: number | null;
   /**
    * The linked facility. Returns the facility ID by default; pass `company_target_facility.facility` to `expand` to receive the full facility object.
    */
@@ -97,7 +97,7 @@ export const CompanyTargetFacility$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: types.number(),
+  id: types.nullable(types.number()),
   facility: types.nullable(
     smartUnion([Facility$inboundSchema, types.number()]),
   ),

package/src/models/components/credit.ts

@@ -10,6 +10,10 @@ 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 {
+  CreditEntitySummary,
+  CreditEntitySummary$inboundSchema,
+} from "./creditentitysummary.js";
 
 export const Action = {
   Credit: "credit",
@@ -18,21 +22,91 @@ export const Action = {
 } as const;
 export type Action = OpenEnum<typeof Action>;
 
+export type CreditsAndDebits = {
+  /**
+   * Compact entity reference by default (`id`, `name`); becomes the entity's full payload when the corresponding `expand` value is requested.
+   */
+  entity?: CreditEntitySummary | null | undefined;
+  invoiceNumber?: string | null | undefined;
+};
+
+export type Transfers = {
+  /**
+   * Compact entity reference by default (`id`, `name`); becomes the entity's full payload when the corresponding `expand` value is requested.
+   */
+  fromEntity?: CreditEntitySummary | null | undefined;
+  /**
+   * Compact entity reference by default (`id`, `name`); becomes the entity's full payload when the corresponding `expand` value is requested.
+   */
+  toEntity?: CreditEntitySummary | null | undefined;
+};
+
 export type Credit = {
   id?: number | undefined;
   date?: string | null | undefined;
   action?: Action | undefined;
   amount?: number | undefined;
-  balance?: number | undefined;
-  from?: string | null | undefined;
-  to?: string | null | undefined;
-  invoiceNumber?: string | null | undefined;
+  /**
+   * Account balance immediately after this transaction (running balance at this point in the ledger). Not the account's current overall balance — see `credit_balance` on the list response for that.
+   */
+  balance?: number | null | undefined;
+  creditsAndDebits?: CreditsAndDebits | undefined;
+  transfers?: Transfers | undefined;
 };
 
 /** @internal */
 export const Action$inboundSchema: z.ZodType<Action, z.ZodTypeDef, unknown> =
   openEnums.inboundSchema(Action);
 
+/** @internal */
+export const CreditsAndDebits$inboundSchema: z.ZodType<
+  CreditsAndDebits,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entity: z.nullable(CreditEntitySummary$inboundSchema).optional(),
+  invoice_number: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "invoice_number": "invoiceNumber",
+  });
+});
+
+export function creditsAndDebitsFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditsAndDebits, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditsAndDebits$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditsAndDebits' from JSON`,
+  );
+}
+
+/** @internal */
+export const Transfers$inboundSchema: z.ZodType<
+  Transfers,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  from_entity: z.nullable(CreditEntitySummary$inboundSchema).optional(),
+  to_entity: z.nullable(CreditEntitySummary$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "from_entity": "fromEntity",
+    "to_entity": "toEntity",
+  });
+});
+
+export function transfersFromJSON(
+  jsonString: string,
+): SafeParseResult<Transfers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Transfers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Transfers' from JSON`,
+  );
+}
+
 /** @internal */
 export const Credit$inboundSchema: z.ZodType<Credit, z.ZodTypeDef, unknown> = z
   .object({
@@ -40,13 +114,14 @@ export const Credit$inboundSchema: z.ZodType<Credit, z.ZodTypeDef, unknown> = z
     date: z.nullable(types.string()).optional(),
     action: types.optional(Action$inboundSchema),
     amount: types.optional(types.number()),
-    balance: types.optional(types.number()),
-    from: z.nullable(types.string()).optional(),
-    to: z.nullable(types.string()).optional(),
-    invoice_number: z.nullable(types.string()).optional(),
+    balance: z.nullable(types.number()).optional(),
+    credits_and_debits: types.optional(
+      z.lazy(() => CreditsAndDebits$inboundSchema),
+    ),
+    transfers: types.optional(z.lazy(() => Transfers$inboundSchema)),
   }).transform((v) => {
     return remap$(v, {
-      "invoice_number": "invoiceNumber",
+      "credits_and_debits": "creditsAndDebits",
     });
   });
 

package/src/models/components/creditentitysummary.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  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";
+
+/**
+ * Compact entity reference by default (`id`, `name`); becomes the entity's full payload when the corresponding `expand` value is requested.
+ */
+export type CreditEntitySummary = {
+  id?: number | undefined;
+  name?: string | null | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreditEntitySummary$inboundSchema: z.ZodType<
+  CreditEntitySummary,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    id: types.optional(types.number()),
+    name: z.nullable(types.string()).optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
+
+export function creditEntitySummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditEntitySummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditEntitySummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditEntitySummary' from JSON`,
+  );
+}

package/src/models/components/csvexportenqueuedresponse.ts

@@ -0,0 +1,58 @@
+/*
+ * 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";
+
+/**
+ * Returned when an asynchronous CSV export job is enqueued. Poll `status_url` until the export is ready,
+ *
+ * @remarks
+ * then retrieve the file from `download_url`.
+ */
+export type CsvExportEnqueuedResponse = {
+  /**
+   * URL to poll for the status of the export job.
+   */
+  statusUrl: string;
+  /**
+   * URL to download the exported CSV file once the job is ready.
+   */
+  downloadUrl: string;
+  /**
+   * Token identifying the export job, used to check its status.
+   */
+  statusId: string;
+};
+
+/** @internal */
+export const CsvExportEnqueuedResponse$inboundSchema: z.ZodType<
+  CsvExportEnqueuedResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status_url: types.string(),
+  download_url: types.string(),
+  status_id: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "status_url": "statusUrl",
+    "download_url": "downloadUrl",
+    "status_id": "statusId",
+  });
+});
+
+export function csvExportEnqueuedResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CsvExportEnqueuedResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CsvExportEnqueuedResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CsvExportEnqueuedResponse' from JSON`,
+  );
+}

package/src/models/components/csvexportstatusresponse.ts

@@ -0,0 +1,79 @@
+/*
+ * 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";
+
+/**
+ * Returned when polling the status of an asynchronous CSV export job. When `ready` is true,
+ *
+ * @remarks
+ * the export is complete and can be downloaded via the URL in `download_url`.
+ */
+export type CsvExportStatusResponse = {
+  /**
+   * 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 const CsvExportStatusResponse$inboundSchema: z.ZodType<
+  CsvExportStatusResponse,
+  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 csvExportStatusResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CsvExportStatusResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CsvExportStatusResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CsvExportStatusResponse' from JSON`,
+  );
+}

package/src/models/components/emailpreferences.ts

@@ -11,30 +11,12 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * Who receives vendor-related notification emails:
- *
- * @remarks
- * - `none` — no recipients
- * - `self` — the user (vendor) themselves
- * - `company_manager` — the vendor's company manager only
- * - `self_and_company_manager` — both
- */
 export const NotificationRecipients = {
   None: "none",
   Self: "self",
   CompanyManager: "company_manager",
   SelfAndCompanyManager: "self_and_company_manager",
 } as const;
-/**
- * Who receives vendor-related notification emails:
- *
- * @remarks
- * - `none` — no recipients
- * - `self` — the user (vendor) themselves
- * - `company_manager` — the vendor's company manager only
- * - `self_and_company_manager` — both
- */
 export type NotificationRecipients = OpenEnum<typeof NotificationRecipients>;
 
 /**
@@ -48,6 +30,10 @@ export type NotificationRecipients = OpenEnum<typeof NotificationRecipients>;
  * Replaces the legacy vendor-side fields `email_recepient` and
  * `send_weekly_summary_email`, which remain on the Vendor object during
  * the migration window but are deprecated.
+ *
+ * `receive_vendor_emails` is company-manager-only and is stored on the
+ * CompanyManager record rather than the User, but is exposed here
+ * alongside the other preferences for a single read/write shape.
  */
 export type EmailPreferences = {
   /**
@@ -68,6 +54,10 @@ export type EmailPreferences = {
    * Whether the user receives the weekly credentialing status summary email.
    */
   sendWeeklyCredentialingStatusEmail?: boolean | undefined;
+  /**
+   * Company-manager-only preference: whether this manager receives a copy of vendor-related notification emails (credential approvals, declines, expirations, etc.) for their company's vendors. Omitted for non-company-manager users. Also depends on each individual vendor's own `notification_recipients` setting including the company manager as a recipient — both must be true for this manager to actually receive a given vendor's emails.
+   */
+  receiveVendorEmails?: boolean | undefined;
 };
 
 /** @internal */
@@ -93,12 +83,14 @@ export const EmailPreferences$inboundSchema: z.ZodType<
     .optional(),
   send_weekly_summary_email: types.optional(types.boolean()),
   send_weekly_credentialing_status_email: types.optional(types.boolean()),
+  receive_vendor_emails: types.optional(types.boolean()),
 }).transform((v) => {
   return remap$(v, {
     "notification_recipients": "notificationRecipients",
     "send_weekly_summary_email": "sendWeeklySummaryEmail",
     "send_weekly_credentialing_status_email":
       "sendWeeklyCredentialingStatusEmail",
+    "receive_vendor_emails": "receiveVendorEmails",
   });
 });
 /** @internal */
@@ -106,6 +98,7 @@ export type EmailPreferences$Outbound = {
   notification_recipients?: string | null | undefined;
   send_weekly_summary_email?: boolean | undefined;
   send_weekly_credentialing_status_email?: boolean | undefined;
+  receive_vendor_emails?: boolean | undefined;
 };
 
 /** @internal */
@@ -118,12 +111,14 @@ export const EmailPreferences$outboundSchema: z.ZodType<
     .optional(),
   sendWeeklySummaryEmail: z.boolean().optional(),
   sendWeeklyCredentialingStatusEmail: z.boolean().optional(),
+  receiveVendorEmails: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     notificationRecipients: "notification_recipients",
     sendWeeklySummaryEmail: "send_weekly_summary_email",
     sendWeeklyCredentialingStatusEmail:
       "send_weekly_credentialing_status_email",
+    receiveVendorEmails: "receive_vendor_emails",
   });
 });
 

package/src/models/components/expand.ts

@@ -16,6 +16,7 @@ export const Expand = {
   CompanyVendorFields: "company.vendor_fields",
   CompanyVendorTypeRestrictions: "company.vendor_type_restrictions",
   CompanyTargetFacilityFacility: "company_target_facility.facility",
+  VendorTargetFacilityFacility: "vendor_target_facility.facility",
   ContactFacility: "contact.facility",
   ContactSystem: "contact.system",
   ContactDepartment: "contact.department",

package/src/models/components/index.ts

@@ -19,6 +19,9 @@ export * from "./credential.js";
 export * from "./credentialdocument.js";
 export * from "./credentialstatus.js";
 export * from "./credit.js";
+export * from "./creditentitysummary.js";
+export * from "./csvexportenqueuedresponse.js";
+export * from "./csvexportstatusresponse.js";
 export * from "./datarequest.js";
 export * from "./deleteapiresponse.js";
 export * from "./department.js";
@@ -86,6 +89,7 @@ export * from "./vendorfacilitystatusview.js";
 export * from "./vendorgroup.js";
 export * from "./vendorjobtitle.js";
 export * from "./vendormanagedbycompany.js";
+export * from "./vendorpaymentresponsibilityassignments.js";
 export * from "./vendorrequiredcredential.js";
 export * from "./vendorscan.js";
 export * from "./vendorscanscreeninganswer.js";
@@ -93,6 +97,7 @@ export * from "./vendorscanscreeningquestion.js";
 export * from "./vendorscanscreeningresponse.js";
 export * from "./vendorscrubdetails.js";
 export * from "./vendorscrubpurchase.js";
+export * from "./vendortargetfacility.js";
 export * from "./vendortype.js";
 export * from "./webhookendpoint.js";
 export * from "./zone.js";

package/src/models/components/productvariant.ts

@@ -10,11 +10,18 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Subscription interval of variant, if any.
+ */
 export const Recurrence = {
   Monthly: "monthly",
   Yearly: "yearly",
+  NinetyDays: "90_days",
   Once: "once",
 } as const;
+/**
+ * Subscription interval of variant, if any.
+ */
 export type Recurrence = OpenEnum<typeof Recurrence>;
 
 /**
@@ -24,6 +31,9 @@ export type ProductVariant = {
   id?: number | undefined;
   price?: number | undefined;
   title?: string | null | undefined;
+  /**
+   * Subscription interval of variant, if any.
+   */
   recurrence?: Recurrence | null | undefined;
 };
 

package/src/models/components/userdetails.ts

@@ -107,6 +107,10 @@ export type UserDetails = {
    * Replaces the legacy vendor-side fields `email_recepient` and
    * `send_weekly_summary_email`, which remain on the Vendor object during
    * the migration window but are deprecated.
+   *
+   * `receive_vendor_emails` is company-manager-only and is stored on the
+   * CompanyManager record rather than the User, but is exposed here
+   * alongside the other preferences for a single read/write shape.
    */
   emailPreferences?: EmailPreferences | undefined;
   /**

package/src/models/components/vendor.ts

@@ -131,6 +131,10 @@ export type Vendor = {
    */
   sendWeeklySummaryEmail?: boolean | null | undefined;
   title?: string | null | undefined;
+  /**
+   * The vendor's primary sales state as a 2-letter US state code (e.g. `TX`), sourced from the vendor's `territory` column.
+   */
+  primarySalesState?: string | null | undefined;
   hasEmeraldStatus?: boolean | null | undefined;
   user?: One | number | undefined;
   registrationData?: { [k: string]: any } | null | undefined;
@@ -440,6 +444,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     email_recepient: z.nullable(types.string()).optional(),
     send_weekly_summary_email: z.nullable(types.boolean()).optional(),
     title: z.nullable(types.string()).optional(),
+    primary_sales_state: z.nullable(types.string()).optional(),
     has_emerald_status: z.nullable(types.boolean()).optional(),
     user: types.optional(
       smartUnion([z.lazy(() => One$inboundSchema), types.number()]),
@@ -497,6 +502,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     return remap$(v, {
       "email_recepient": "emailRecepient",
       "send_weekly_summary_email": "sendWeeklySummaryEmail",
+      "primary_sales_state": "primarySalesState",
       "has_emerald_status": "hasEmeraldStatus",
       "registration_data": "registrationData",
       "registration_finished": "registrationFinished",

package/src/models/components/vendorpaymentresponsibilityassignments.ts

@@ -0,0 +1,95 @@
+/*
+ * 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";
+
+/**
+ * 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.
+ */
+export type VendorPaymentResponsibilityAssignments = {
+  /**
+   * Unique identifier for the payment responsibility record. `null` when no record has been persisted yet.
+   */
+  id?: number | null | undefined;
+  /**
+   * ID of the vendor this record applies to.
+   */
+  vendorId: number;
+  /**
+   * ID of the managing company this record applies to.
+   */
+  companyId?: number | null | undefined;
+  /**
+   * User ID responsible for Credentialing Subscription & Expediting
+   *
+   * @remarks
+   * payments. `null` means the vendor is responsible.
+   */
+  credentialingSubscriptionUserId?: number | null | undefined;
+  /**
+   * User ID responsible for Initial Hard Badge payments.
+   *
+   * @remarks
+   * `null` means the vendor is responsible.
+   */
+  hardBadgeInitialUserId?: number | null | undefined;
+  /**
+   * User ID responsible for Additional Hard Badge payments.
+   *
+   * @remarks
+   * `null` means the vendor is responsible.
+   */
+  hardBadgeExtraUserId?: number | null | undefined;
+  /**
+   * User ID responsible for all other invoice payments.
+   *
+   * @remarks
+   * `null` means the vendor is responsible.
+   */
+  otherInvoicesUserId?: number | null | undefined;
+};
+
+/** @internal */
+export const VendorPaymentResponsibilityAssignments$inboundSchema: z.ZodType<
+  VendorPaymentResponsibilityAssignments,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.nullable(types.number()).optional(),
+  vendor_id: types.number(),
+  company_id: z.nullable(types.number()).optional(),
+  credentialing_subscription_user_id: z.nullable(types.number()).optional(),
+  hard_badge_initial_user_id: z.nullable(types.number()).optional(),
+  hard_badge_extra_user_id: z.nullable(types.number()).optional(),
+  other_invoices_user_id: z.nullable(types.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "vendor_id": "vendorId",
+    "company_id": "companyId",
+    "credentialing_subscription_user_id": "credentialingSubscriptionUserId",
+    "hard_badge_initial_user_id": "hardBadgeInitialUserId",
+    "hard_badge_extra_user_id": "hardBadgeExtraUserId",
+    "other_invoices_user_id": "otherInvoicesUserId",
+  });
+});
+
+export function vendorPaymentResponsibilityAssignmentsFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorPaymentResponsibilityAssignments, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VendorPaymentResponsibilityAssignments$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorPaymentResponsibilityAssignments' from JSON`,
+  );
+}