@greensecurity/javascript-sdk 0.44.0-beta.7 → 0.44.0-beta.71

package/src/models/components/companyvendortyperestriction.ts

@@ -12,8 +12,15 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
   FacilitySummary,
   FacilitySummary$inboundSchema,
+  FacilitySummary$Outbound,
+  FacilitySummary$outboundSchema,
 } from "./facilitysummary.js";
-import { VendorType, VendorType$inboundSchema } from "./vendortype.js";
+import {
+  VendorType,
+  VendorType$inboundSchema,
+  VendorType$Outbound,
+  VendorType$outboundSchema,
+} from "./vendortype.js";
 
 export type CompanyVendorTypeRestrictionFacility = FacilitySummary | number;
 
@@ -34,7 +41,27 @@ export const CompanyVendorTypeRestrictionFacility$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = smartUnion([FacilitySummary$inboundSchema, types.number()]);
+/** @internal */
+export type CompanyVendorTypeRestrictionFacility$Outbound =
+  | FacilitySummary$Outbound
+  | number;
+
+/** @internal */
+export const CompanyVendorTypeRestrictionFacility$outboundSchema: z.ZodType<
+  CompanyVendorTypeRestrictionFacility$Outbound,
+  z.ZodTypeDef,
+  CompanyVendorTypeRestrictionFacility
+> = smartUnion([FacilitySummary$outboundSchema, z.number().int()]);
 
+export function companyVendorTypeRestrictionFacilityToJSON(
+  companyVendorTypeRestrictionFacility: CompanyVendorTypeRestrictionFacility,
+): string {
+  return JSON.stringify(
+    CompanyVendorTypeRestrictionFacility$outboundSchema.parse(
+      companyVendorTypeRestrictionFacility,
+    ),
+  );
+}
 export function companyVendorTypeRestrictionFacilityFromJSON(
   jsonString: string,
 ): SafeParseResult<CompanyVendorTypeRestrictionFacility, SDKValidationError> {
@@ -52,7 +79,28 @@ export const CompanyVendorTypeRestrictionVendorType$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = smartUnion([VendorType$inboundSchema, types.number()]);
+/** @internal */
+export type CompanyVendorTypeRestrictionVendorType$Outbound =
+  | VendorType$Outbound
+  | number;
 
+/** @internal */
+export const CompanyVendorTypeRestrictionVendorType$outboundSchema: z.ZodType<
+  CompanyVendorTypeRestrictionVendorType$Outbound,
+  z.ZodTypeDef,
+  CompanyVendorTypeRestrictionVendorType
+> = smartUnion([VendorType$outboundSchema, z.number().int()]);
+
+export function companyVendorTypeRestrictionVendorTypeToJSON(
+  companyVendorTypeRestrictionVendorType:
+    CompanyVendorTypeRestrictionVendorType,
+): string {
+  return JSON.stringify(
+    CompanyVendorTypeRestrictionVendorType$outboundSchema.parse(
+      companyVendorTypeRestrictionVendorType,
+    ),
+  );
+}
 export function companyVendorTypeRestrictionVendorTypeFromJSON(
   jsonString: string,
 ): SafeParseResult<CompanyVendorTypeRestrictionVendorType, SDKValidationError> {
@@ -82,7 +130,41 @@ export const CompanyVendorTypeRestriction$inboundSchema: z.ZodType<
     "vendor_type": "vendorType",
   });
 });
+/** @internal */
+export type CompanyVendorTypeRestriction$Outbound = {
+  id?: number | undefined;
+  facility?: FacilitySummary$Outbound | number | null | undefined;
+  vendor_type?: VendorType$Outbound | number | null | undefined;
+};
+
+/** @internal */
+export const CompanyVendorTypeRestriction$outboundSchema: z.ZodType<
+  CompanyVendorTypeRestriction$Outbound,
+  z.ZodTypeDef,
+  CompanyVendorTypeRestriction
+> = z.object({
+  id: z.number().int().optional(),
+  facility: z.nullable(
+    smartUnion([FacilitySummary$outboundSchema, z.number().int()]),
+  ).optional(),
+  vendorType: z.nullable(
+    smartUnion([VendorType$outboundSchema, z.number().int()]),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    vendorType: "vendor_type",
+  });
+});
 
+export function companyVendorTypeRestrictionToJSON(
+  companyVendorTypeRestriction: CompanyVendorTypeRestriction,
+): string {
+  return JSON.stringify(
+    CompanyVendorTypeRestriction$outboundSchema.parse(
+      companyVendorTypeRestriction,
+    ),
+  );
+}
 export function companyVendorTypeRestrictionFromJSON(
   jsonString: string,
 ): SafeParseResult<CompanyVendorTypeRestriction, SDKValidationError> {

package/src/models/components/contact.ts

@@ -13,13 +13,27 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
   DepartmentSummary,
   DepartmentSummary$inboundSchema,
+  DepartmentSummary$Outbound,
+  DepartmentSummary$outboundSchema,
 } from "./departmentsummary.js";
 import {
   FacilitySummary,
   FacilitySummary$inboundSchema,
+  FacilitySummary$Outbound,
+  FacilitySummary$outboundSchema,
 } from "./facilitysummary.js";
-import { SystemSummary, SystemSummary$inboundSchema } from "./systemsummary.js";
-import { UserSummary, UserSummary$inboundSchema } from "./usersummary.js";
+import {
+  SystemSummary,
+  SystemSummary$inboundSchema,
+  SystemSummary$Outbound,
+  SystemSummary$outboundSchema,
+} from "./systemsummary.js";
+import {
+  UserSummary,
+  UserSummary$inboundSchema,
+  UserSummary$Outbound,
+  UserSummary$outboundSchema,
+} from "./usersummary.js";
 
 export type ContactFacility = FacilitySummary | number;
 
@@ -55,7 +69,21 @@ export const ContactFacility$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = smartUnion([FacilitySummary$inboundSchema, types.number()]);
+/** @internal */
+export type ContactFacility$Outbound = FacilitySummary$Outbound | number;
+
+/** @internal */
+export const ContactFacility$outboundSchema: z.ZodType<
+  ContactFacility$Outbound,
+  z.ZodTypeDef,
+  ContactFacility
+> = smartUnion([FacilitySummary$outboundSchema, z.number().int()]);
 
+export function contactFacilityToJSON(
+  contactFacility: ContactFacility,
+): string {
+  return JSON.stringify(ContactFacility$outboundSchema.parse(contactFacility));
+}
 export function contactFacilityFromJSON(
   jsonString: string,
 ): SafeParseResult<ContactFacility, SDKValidationError> {
@@ -69,7 +97,19 @@ export function contactFacilityFromJSON(
 /** @internal */
 export const System$inboundSchema: z.ZodType<System, z.ZodTypeDef, unknown> =
   smartUnion([SystemSummary$inboundSchema, types.number()]);
+/** @internal */
+export type System$Outbound = SystemSummary$Outbound | number;
 
+/** @internal */
+export const System$outboundSchema: z.ZodType<
+  System$Outbound,
+  z.ZodTypeDef,
+  System
+> = smartUnion([SystemSummary$outboundSchema, z.number().int()]);
+
+export function systemToJSON(system: System): string {
+  return JSON.stringify(System$outboundSchema.parse(system));
+}
 export function systemFromJSON(
   jsonString: string,
 ): SafeParseResult<System, SDKValidationError> {
@@ -86,7 +126,19 @@ export const ContactUser$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = smartUnion([UserSummary$inboundSchema, types.number()]);
+/** @internal */
+export type ContactUser$Outbound = UserSummary$Outbound | number;
+
+/** @internal */
+export const ContactUser$outboundSchema: z.ZodType<
+  ContactUser$Outbound,
+  z.ZodTypeDef,
+  ContactUser
+> = smartUnion([UserSummary$outboundSchema, z.number().int()]);
 
+export function contactUserToJSON(contactUser: ContactUser): string {
+  return JSON.stringify(ContactUser$outboundSchema.parse(contactUser));
+}
 export function contactUserFromJSON(
   jsonString: string,
 ): SafeParseResult<ContactUser, SDKValidationError> {
@@ -100,6 +152,9 @@ export function contactUserFromJSON(
 /** @internal */
 export const Status$inboundSchema: z.ZodType<Status, z.ZodTypeDef, unknown> =
   openEnums.inboundSchema(Status);
+/** @internal */
+export const Status$outboundSchema: z.ZodType<string, z.ZodTypeDef, Status> =
+  openEnums.outboundSchema(Status);
 
 /** @internal */
 export const ContactDepartment$inboundSchema: z.ZodType<
@@ -107,7 +162,23 @@ export const ContactDepartment$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = smartUnion([DepartmentSummary$inboundSchema, types.number()]);
+/** @internal */
+export type ContactDepartment$Outbound = DepartmentSummary$Outbound | number;
 
+/** @internal */
+export const ContactDepartment$outboundSchema: z.ZodType<
+  ContactDepartment$Outbound,
+  z.ZodTypeDef,
+  ContactDepartment
+> = smartUnion([DepartmentSummary$outboundSchema, z.number().int()]);
+
+export function contactDepartmentToJSON(
+  contactDepartment: ContactDepartment,
+): string {
+  return JSON.stringify(
+    ContactDepartment$outboundSchema.parse(contactDepartment),
+  );
+}
 export function contactDepartmentFromJSON(
   jsonString: string,
 ): SafeParseResult<ContactDepartment, SDKValidationError> {
@@ -136,7 +207,42 @@ export const Contact$inboundSchema: z.ZodType<Contact, z.ZodTypeDef, unknown> =
       smartUnion([DepartmentSummary$inboundSchema, types.number()]),
     ).optional(),
   });
+/** @internal */
+export type Contact$Outbound = {
+  id?: number | undefined;
+  facility?: FacilitySummary$Outbound | number | null | undefined;
+  system?: SystemSummary$Outbound | number | null | undefined;
+  user?: UserSummary$Outbound | number | null | undefined;
+  status: string;
+  position?: string | null | undefined;
+  department?: DepartmentSummary$Outbound | number | null | undefined;
+};
 
+/** @internal */
+export const Contact$outboundSchema: z.ZodType<
+  Contact$Outbound,
+  z.ZodTypeDef,
+  Contact
+> = z.object({
+  id: z.number().int().optional(),
+  facility: z.nullable(
+    smartUnion([FacilitySummary$outboundSchema, z.number().int()]),
+  ).optional(),
+  system: z.nullable(
+    smartUnion([SystemSummary$outboundSchema, z.number().int()]),
+  ).optional(),
+  user: z.nullable(smartUnion([UserSummary$outboundSchema, z.number().int()]))
+    .optional(),
+  status: Status$outboundSchema,
+  position: z.nullable(z.string()).optional(),
+  department: z.nullable(
+    smartUnion([DepartmentSummary$outboundSchema, z.number().int()]),
+  ).optional(),
+});
+
+export function contactToJSON(contact: Contact): string {
+  return JSON.stringify(Contact$outboundSchema.parse(contact));
+}
 export function contactFromJSON(
   jsonString: string,
 ): SafeParseResult<Contact, SDKValidationError> {

package/src/models/components/credit.ts

@@ -10,43 +10,127 @@ 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 = {
+export const CreditAction = {
   Credit: "credit",
   Debit: "debit",
   Transfer: "transfer",
 } as const;
-export type Action = OpenEnum<typeof Action>;
+export type CreditAction = OpenEnum<typeof CreditAction>;
+
+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;
+  /**
+   * The invoice's numeric id — use this (not invoice_number) to link to invoice details.
+   */
+  invoiceId?: number | 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;
+  action?: CreditAction | 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);
+export const CreditAction$inboundSchema: z.ZodType<
+  CreditAction,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CreditAction);
+
+/** @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(),
+  invoice_id: z.nullable(types.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "invoice_number": "invoiceNumber",
+    "invoice_id": "invoiceId",
+  });
+});
+
+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({
     id: types.optional(types.number()),
     date: z.nullable(types.string()).optional(),
-    action: types.optional(Action$inboundSchema),
+    action: types.optional(CreditAction$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/department.ts

@@ -25,7 +25,25 @@ export const Department$inboundSchema: z.ZodType<
   id: types.number(),
   name: types.string(),
 });
+/** @internal */
+export type Department$Outbound = {
+  id: number;
+  name: string;
+};
+
+/** @internal */
+export const Department$outboundSchema: z.ZodType<
+  Department$Outbound,
+  z.ZodTypeDef,
+  Department
+> = z.object({
+  id: z.number().int(),
+  name: z.string(),
+});
 
+export function departmentToJSON(department: Department): string {
+  return JSON.stringify(Department$outboundSchema.parse(department));
+}
 export function departmentFromJSON(
   jsonString: string,
 ): SafeParseResult<Department, SDKValidationError> {

package/src/models/components/departmentsummary.ts

@@ -25,7 +25,29 @@ export const DepartmentSummary$inboundSchema: z.ZodType<
   id: types.number(),
   name: types.string(),
 });
+/** @internal */
+export type DepartmentSummary$Outbound = {
+  id: number;
+  name: string;
+};
 
+/** @internal */
+export const DepartmentSummary$outboundSchema: z.ZodType<
+  DepartmentSummary$Outbound,
+  z.ZodTypeDef,
+  DepartmentSummary
+> = z.object({
+  id: z.number().int(),
+  name: z.string(),
+});
+
+export function departmentSummaryToJSON(
+  departmentSummary: DepartmentSummary,
+): string {
+  return JSON.stringify(
+    DepartmentSummary$outboundSchema.parse(departmentSummary),
+  );
+}
 export function departmentSummaryFromJSON(
   jsonString: string,
 ): SafeParseResult<DepartmentSummary, SDKValidationError> {