@greensecurity/javascript-sdk 0.45.0-beta.9 → 0.45.0

package/src/models/operations/listcompanymanagercontacts.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 ListCompanyManagerContactsRequest = {
+  /**
+   * Id of the company whose managers are being listed.
+   */
+  companyId: number;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListCompanyManagerContactsListCompanyManagerContactsOk = {
+  items: Array<components.CompanyManagerLookup>;
+};
+
+/** @internal */
+export type ListCompanyManagerContactsRequest$Outbound = {
+  company_id: number;
+};
+
+/** @internal */
+export const ListCompanyManagerContactsRequest$outboundSchema: z.ZodType<
+  ListCompanyManagerContactsRequest$Outbound,
+  z.ZodTypeDef,
+  ListCompanyManagerContactsRequest
+> = z.object({
+  companyId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+  });
+});
+
+export function listCompanyManagerContactsRequestToJSON(
+  listCompanyManagerContactsRequest: ListCompanyManagerContactsRequest,
+): string {
+  return JSON.stringify(
+    ListCompanyManagerContactsRequest$outboundSchema.parse(
+      listCompanyManagerContactsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListCompanyManagerContactsListCompanyManagerContactsOk$inboundSchema:
+  z.ZodType<
+    ListCompanyManagerContactsListCompanyManagerContactsOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    items: z.array(components.CompanyManagerLookup$inboundSchema),
+  });
+
+export function listCompanyManagerContactsListCompanyManagerContactsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListCompanyManagerContactsListCompanyManagerContactsOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListCompanyManagerContactsListCompanyManagerContactsOk$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ListCompanyManagerContactsListCompanyManagerContactsOk' from JSON`,
+  );
+}

package/src/models/operations/listcompanytargetfacilities.ts

@@ -126,6 +126,10 @@ export type ListCompanyTargetFacilitiesRequest = {
    * Case-insensitive partial match on the facility's parent system name.
    */
   systemNameLike?: string | undefined;
+  /**
+   * Exact match on the facility's parent system id. Returns only facilities whose `system.id` is one of the given values.
+   */
+  systemIds?: Array<number> | undefined;
   /**
    * Case-insensitive partial match across facility name, city, state, street address, and system name (OR logic). Use this for a single search-box query; use the field-specific `*_like` params for multi-field AND filtering.
    */
@@ -201,6 +205,7 @@ export type ListCompanyTargetFacilitiesRequest$Outbound = {
   state_like?: string | undefined;
   address_like?: string | undefined;
   system_name_like?: string | undefined;
+  system_ids?: Array<number> | undefined;
   search_like?: string | undefined;
   sort?: string | undefined;
   desc?: components.Desc$Outbound | undefined;
@@ -225,6 +230,7 @@ export const ListCompanyTargetFacilitiesRequest$outboundSchema: z.ZodType<
   stateLike: z.string().optional(),
   addressLike: z.string().optional(),
   systemNameLike: z.string().optional(),
+  systemIds: z.array(z.number().int()).optional(),
   searchLike: z.string().optional(),
   sort: QueryParamSort$outboundSchema.optional(),
   desc: components.Desc$outboundSchema.optional(),
@@ -241,6 +247,7 @@ export const ListCompanyTargetFacilitiesRequest$outboundSchema: z.ZodType<
     stateLike: "state_like",
     addressLike: "address_like",
     systemNameLike: "system_name_like",
+    systemIds: "system_ids",
     searchLike: "search_like",
     itemsPerPage: "items_per_page",
   });

package/src/models/operations/lookupcompanymanagers.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 LookupCompanyManagersRequest = {
+  /**
+   * Id of the company whose managers are being listed.
+   */
+  companyId: number;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type LookupCompanyManagersLookupCompanyManagersOk = {
+  items: Array<components.CompanyManagerLookup>;
+};
+
+/** @internal */
+export type LookupCompanyManagersRequest$Outbound = {
+  company_id: number;
+};
+
+/** @internal */
+export const LookupCompanyManagersRequest$outboundSchema: z.ZodType<
+  LookupCompanyManagersRequest$Outbound,
+  z.ZodTypeDef,
+  LookupCompanyManagersRequest
+> = z.object({
+  companyId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+  });
+});
+
+export function lookupCompanyManagersRequestToJSON(
+  lookupCompanyManagersRequest: LookupCompanyManagersRequest,
+): string {
+  return JSON.stringify(
+    LookupCompanyManagersRequest$outboundSchema.parse(
+      lookupCompanyManagersRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const LookupCompanyManagersLookupCompanyManagersOk$inboundSchema:
+  z.ZodType<
+    LookupCompanyManagersLookupCompanyManagersOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    items: z.array(components.CompanyManagerLookup$inboundSchema),
+  });
+
+export function lookupCompanyManagersLookupCompanyManagersOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  LookupCompanyManagersLookupCompanyManagersOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      LookupCompanyManagersLookupCompanyManagersOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'LookupCompanyManagersLookupCompanyManagersOk' from JSON`,
+  );
+}

package/src/models/operations/lookuppostalcode.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 type LookupPostalCodeRequest = {
+  /**
+   * The zip / postal code to check.
+   */
+  postalCode: string;
+  /**
+   * The state or province, as a code or full name, entered alongside the postal code.
+   */
+  state: string;
+  /**
+   * The country entered alongside the postal code (e.g. US, CA).
+   */
+  country: string;
+};
+
+export const LookupPostalCodeStatus = {
+  Ok: "ok",
+  Invalid: "invalid",
+  Mismatch: "mismatch",
+  Unknown: "unknown",
+} as const;
+export type LookupPostalCodeStatus = OpenEnum<typeof LookupPostalCodeStatus>;
+
+/**
+ * The request was successful, and the server has returned the check result in the response body.
+ */
+export type LookupPostalCodeLookupPostalCodeOk = {
+  status: LookupPostalCodeStatus;
+  /**
+   * The state(s)/province(s) the postal code actually belongs to. Populated whenever the
+   *
+   * @remarks
+   * postal code is well-formed and a state/province was checked against it — so this is
+   * non-empty for `ok` (it names the state that matched) as well as for `mismatch`, and
+   * empty for `invalid` and `unknown`.
+   */
+  expectedStates: Array<string>;
+  /**
+   * A human-readable explanation of the problem. `null` unless `status` is `invalid` or `mismatch`.
+   */
+  error: string | null;
+};
+
+/** @internal */
+export type LookupPostalCodeRequest$Outbound = {
+  postal_code: string;
+  state: string;
+  country: string;
+};
+
+/** @internal */
+export const LookupPostalCodeRequest$outboundSchema: z.ZodType<
+  LookupPostalCodeRequest$Outbound,
+  z.ZodTypeDef,
+  LookupPostalCodeRequest
+> = z.object({
+  postalCode: z.string(),
+  state: z.string(),
+  country: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    postalCode: "postal_code",
+  });
+});
+
+export function lookupPostalCodeRequestToJSON(
+  lookupPostalCodeRequest: LookupPostalCodeRequest,
+): string {
+  return JSON.stringify(
+    LookupPostalCodeRequest$outboundSchema.parse(lookupPostalCodeRequest),
+  );
+}
+
+/** @internal */
+export const LookupPostalCodeStatus$inboundSchema: z.ZodType<
+  LookupPostalCodeStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(LookupPostalCodeStatus);
+
+/** @internal */
+export const LookupPostalCodeLookupPostalCodeOk$inboundSchema: z.ZodType<
+  LookupPostalCodeLookupPostalCodeOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: LookupPostalCodeStatus$inboundSchema,
+  expected_states: z.array(types.string()),
+  error: types.nullable(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "expected_states": "expectedStates",
+  });
+});
+
+export function lookupPostalCodeLookupPostalCodeOkFromJSON(
+  jsonString: string,
+): SafeParseResult<LookupPostalCodeLookupPostalCodeOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      LookupPostalCodeLookupPostalCodeOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LookupPostalCodeLookupPostalCodeOk' from JSON`,
+  );
+}

package/src/models/operations/postauthenticate.ts

@@ -26,7 +26,7 @@ export type PostAuthenticateResponseBody =
   | components.PasswordNotSetResponse;
 
 export type PostAuthenticateResponse =
-  | components.User
+  | components.AuthenticateSuccessResponse
   | components.MfaRequiredResponse
   | components.SamlLoginRequiredResponse
   | components.PasswordRequiredResponse
@@ -85,7 +85,7 @@ export const PostAuthenticateResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = smartUnion([
-  components.User$inboundSchema,
+  components.AuthenticateSuccessResponse$inboundSchema,
   z.union([
     components.MfaRequiredResponse$inboundSchema,
     components.SamlLoginRequiredResponse$inboundSchema,

package/src/models/webhooks/index.ts

@@ -2,6 +2,9 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./sendfullreportcreated.js";
+export * from "./sendfullreportdestroyed.js";
+export * from "./sendfullreportupdated.js";
 export * from "./sendtargetfacilitystatuschangecreated.js";
 export * from "./sendtargetfacilitystatuschangedestroyed.js";
 export * from "./sendtargetfacilitystatuschangeupdated.js";

package/src/models/webhooks/sendfullreportcreated.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 SendFullReportCreatedRequest = {
+  /**
+   * `t=<unix seconds>,v1=<hex hmac>`, one `v1` per active secret. Each is
+   *
+   * @remarks
+   * `HMAC-SHA256(secret, "<t>.<raw body>")`. Compare with a constant-time function and
+   * reject a timestamp that is not recent.
+   */
+  greenSecuritySignature: string;
+  /**
+   * The event this delivery belongs to. Route on it when one URL serves several events.
+   */
+  greenSecurityEvent: string;
+  /**
+   * Stable per delivery, including across retries. Key your de-duplication on it.
+   */
+  greenSecurityIdempotencyKey: string;
+  /**
+   * The entity in the body.
+   */
+  greenWebhookId: string;
+  fullReport: components.FullReport;
+};
+
+/** @internal */
+export const SendFullReportCreatedRequest$inboundSchema: z.ZodType<
+  SendFullReportCreatedRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Green-Security-Signature": types.string(),
+  "Green-Security-Event": types.string(),
+  "Green-Security-Idempotency-Key": types.string(),
+  "Green-Webhook-Id": types.string(),
+  FullReport: components.FullReport$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Green-Security-Signature": "greenSecuritySignature",
+    "Green-Security-Event": "greenSecurityEvent",
+    "Green-Security-Idempotency-Key": "greenSecurityIdempotencyKey",
+    "Green-Webhook-Id": "greenWebhookId",
+    "FullReport": "fullReport",
+  });
+});
+/** @internal */
+export type SendFullReportCreatedRequest$Outbound = {
+  "Green-Security-Signature": string;
+  "Green-Security-Event": string;
+  "Green-Security-Idempotency-Key": string;
+  "Green-Webhook-Id": string;
+  FullReport: components.FullReport$Outbound;
+};
+
+/** @internal */
+export const SendFullReportCreatedRequest$outboundSchema: z.ZodType<
+  SendFullReportCreatedRequest$Outbound,
+  z.ZodTypeDef,
+  SendFullReportCreatedRequest
+> = z.object({
+  greenSecuritySignature: z.string(),
+  greenSecurityEvent: z.string(),
+  greenSecurityIdempotencyKey: z.string(),
+  greenWebhookId: z.string(),
+  fullReport: components.FullReport$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    greenSecuritySignature: "Green-Security-Signature",
+    greenSecurityEvent: "Green-Security-Event",
+    greenSecurityIdempotencyKey: "Green-Security-Idempotency-Key",
+    greenWebhookId: "Green-Webhook-Id",
+    fullReport: "FullReport",
+  });
+});
+
+export function sendFullReportCreatedRequestToJSON(
+  sendFullReportCreatedRequest: SendFullReportCreatedRequest,
+): string {
+  return JSON.stringify(
+    SendFullReportCreatedRequest$outboundSchema.parse(
+      sendFullReportCreatedRequest,
+    ),
+  );
+}
+export function sendFullReportCreatedRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendFullReportCreatedRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendFullReportCreatedRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendFullReportCreatedRequest' from JSON`,
+  );
+}

package/src/models/webhooks/sendfullreportdestroyed.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 SendFullReportDestroyedRequest = {
+  /**
+   * `t=<unix seconds>,v1=<hex hmac>`, one `v1` per active secret. Each is
+   *
+   * @remarks
+   * `HMAC-SHA256(secret, "<t>.<raw body>")`. Compare with a constant-time function and
+   * reject a timestamp that is not recent.
+   */
+  greenSecuritySignature: string;
+  /**
+   * The event this delivery belongs to. Route on it when one URL serves several events.
+   */
+  greenSecurityEvent: string;
+  /**
+   * Stable per delivery, including across retries. Key your de-duplication on it.
+   */
+  greenSecurityIdempotencyKey: string;
+  /**
+   * The entity in the body.
+   */
+  greenWebhookId: string;
+  fullReport: components.FullReport;
+};
+
+/** @internal */
+export const SendFullReportDestroyedRequest$inboundSchema: z.ZodType<
+  SendFullReportDestroyedRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Green-Security-Signature": types.string(),
+  "Green-Security-Event": types.string(),
+  "Green-Security-Idempotency-Key": types.string(),
+  "Green-Webhook-Id": types.string(),
+  FullReport: components.FullReport$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Green-Security-Signature": "greenSecuritySignature",
+    "Green-Security-Event": "greenSecurityEvent",
+    "Green-Security-Idempotency-Key": "greenSecurityIdempotencyKey",
+    "Green-Webhook-Id": "greenWebhookId",
+    "FullReport": "fullReport",
+  });
+});
+/** @internal */
+export type SendFullReportDestroyedRequest$Outbound = {
+  "Green-Security-Signature": string;
+  "Green-Security-Event": string;
+  "Green-Security-Idempotency-Key": string;
+  "Green-Webhook-Id": string;
+  FullReport: components.FullReport$Outbound;
+};
+
+/** @internal */
+export const SendFullReportDestroyedRequest$outboundSchema: z.ZodType<
+  SendFullReportDestroyedRequest$Outbound,
+  z.ZodTypeDef,
+  SendFullReportDestroyedRequest
+> = z.object({
+  greenSecuritySignature: z.string(),
+  greenSecurityEvent: z.string(),
+  greenSecurityIdempotencyKey: z.string(),
+  greenWebhookId: z.string(),
+  fullReport: components.FullReport$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    greenSecuritySignature: "Green-Security-Signature",
+    greenSecurityEvent: "Green-Security-Event",
+    greenSecurityIdempotencyKey: "Green-Security-Idempotency-Key",
+    greenWebhookId: "Green-Webhook-Id",
+    fullReport: "FullReport",
+  });
+});
+
+export function sendFullReportDestroyedRequestToJSON(
+  sendFullReportDestroyedRequest: SendFullReportDestroyedRequest,
+): string {
+  return JSON.stringify(
+    SendFullReportDestroyedRequest$outboundSchema.parse(
+      sendFullReportDestroyedRequest,
+    ),
+  );
+}
+export function sendFullReportDestroyedRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendFullReportDestroyedRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendFullReportDestroyedRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendFullReportDestroyedRequest' from JSON`,
+  );
+}

package/src/models/webhooks/sendfullreportupdated.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 SendFullReportUpdatedRequest = {
+  /**
+   * `t=<unix seconds>,v1=<hex hmac>`, one `v1` per active secret. Each is
+   *
+   * @remarks
+   * `HMAC-SHA256(secret, "<t>.<raw body>")`. Compare with a constant-time function and
+   * reject a timestamp that is not recent.
+   */
+  greenSecuritySignature: string;
+  /**
+   * The event this delivery belongs to. Route on it when one URL serves several events.
+   */
+  greenSecurityEvent: string;
+  /**
+   * Stable per delivery, including across retries. Key your de-duplication on it.
+   */
+  greenSecurityIdempotencyKey: string;
+  /**
+   * The entity in the body.
+   */
+  greenWebhookId: string;
+  fullReport: components.FullReport;
+};
+
+/** @internal */
+export const SendFullReportUpdatedRequest$inboundSchema: z.ZodType<
+  SendFullReportUpdatedRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Green-Security-Signature": types.string(),
+  "Green-Security-Event": types.string(),
+  "Green-Security-Idempotency-Key": types.string(),
+  "Green-Webhook-Id": types.string(),
+  FullReport: components.FullReport$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Green-Security-Signature": "greenSecuritySignature",
+    "Green-Security-Event": "greenSecurityEvent",
+    "Green-Security-Idempotency-Key": "greenSecurityIdempotencyKey",
+    "Green-Webhook-Id": "greenWebhookId",
+    "FullReport": "fullReport",
+  });
+});
+/** @internal */
+export type SendFullReportUpdatedRequest$Outbound = {
+  "Green-Security-Signature": string;
+  "Green-Security-Event": string;
+  "Green-Security-Idempotency-Key": string;
+  "Green-Webhook-Id": string;
+  FullReport: components.FullReport$Outbound;
+};
+
+/** @internal */
+export const SendFullReportUpdatedRequest$outboundSchema: z.ZodType<
+  SendFullReportUpdatedRequest$Outbound,
+  z.ZodTypeDef,
+  SendFullReportUpdatedRequest
+> = z.object({
+  greenSecuritySignature: z.string(),
+  greenSecurityEvent: z.string(),
+  greenSecurityIdempotencyKey: z.string(),
+  greenWebhookId: z.string(),
+  fullReport: components.FullReport$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    greenSecuritySignature: "Green-Security-Signature",
+    greenSecurityEvent: "Green-Security-Event",
+    greenSecurityIdempotencyKey: "Green-Security-Idempotency-Key",
+    greenWebhookId: "Green-Webhook-Id",
+    fullReport: "FullReport",
+  });
+});
+
+export function sendFullReportUpdatedRequestToJSON(
+  sendFullReportUpdatedRequest: SendFullReportUpdatedRequest,
+): string {
+  return JSON.stringify(
+    SendFullReportUpdatedRequest$outboundSchema.parse(
+      sendFullReportUpdatedRequest,
+    ),
+  );
+}
+export function sendFullReportUpdatedRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendFullReportUpdatedRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendFullReportUpdatedRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendFullReportUpdatedRequest' from JSON`,
+  );
+}