@greensecurity/javascript-sdk 0.44.0-beta.1 → 0.44.0-beta.11

package/src/models/operations/listcompanytargetfacilities.ts

@@ -0,0 +1,291 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter by link status.
+ */
+export const QueryParamStatus = {
+  Pending: "pending",
+  Approved: "approved",
+  Denied: "denied",
+} as const;
+/**
+ * Filter by link status.
+ */
+export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
+
+/**
+ * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+ */
+export const HasIndividual = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+ */
+export type HasIndividual = ClosedEnum<typeof HasIndividual>;
+
+/**
+ * Like `has_individual`, but only counts individuals whose credentialing subscription is active.
+ */
+export const HasActiveIndividual = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * Like `has_individual`, but only counts individuals whose credentialing subscription is active.
+ */
+export type HasActiveIndividual = ClosedEnum<typeof HasActiveIndividual>;
+
+/**
+ * When `true`, returns ALL non-deleted facilities via LEFT JOIN. Targeted rows carry their CTF id and status; non-targeted rows have `id: null` and `status: "Not Targeted"`.
+ */
+export const IncludePotentialTargets = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * When `true`, returns ALL non-deleted facilities via LEFT JOIN. Targeted rows carry their CTF id and status; non-targeted rows have `id: null` and `status: "Not Targeted"`.
+ */
+export type IncludePotentialTargets = ClosedEnum<
+  typeof IncludePotentialTargets
+>;
+
+/**
+ * Sort field (defaults to `facility_name`). When `include_potential_targets=true`, only `facility_name`, `system_name`, `city`, and `status` are applicable.
+ */
+export const QueryParamSort = {
+  Id: "id",
+  FacilityName: "facility_name",
+  SystemName: "system_name",
+  Status: "status",
+  DateCreated: "date_created",
+  City: "city",
+} as const;
+/**
+ * Sort field (defaults to `facility_name`). When `include_potential_targets=true`, only `facility_name`, `system_name`, `city`, and `status` are applicable.
+ */
+export type QueryParamSort = ClosedEnum<typeof QueryParamSort>;
+
+export type ListCompanyTargetFacilitiesRequest = {
+  /**
+   * The company whose target facilities to list.
+   */
+  companyId: 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;
+  /**
+   * Filter by link status.
+   */
+  status?: QueryParamStatus | undefined;
+  /**
+   * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+   */
+  hasIndividual?: HasIndividual | undefined;
+  /**
+   * Like `has_individual`, but only counts individuals whose credentialing subscription is active.
+   */
+  hasActiveIndividual?: HasActiveIndividual | undefined;
+  /**
+   * When `true`, returns ALL non-deleted facilities via LEFT JOIN. Targeted rows carry their CTF id and status; non-targeted rows have `id: null` and `status: "Not Targeted"`.
+   */
+  includePotentialTargets?: IncludePotentialTargets | undefined;
+  /**
+   * Case-insensitive partial match on facility name.
+   */
+  facilityNameLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on facility city.
+   */
+  cityLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on facility street address.
+   */
+  addressLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on the facility's parent system name.
+   */
+  systemNameLike?: string | undefined;
+  /**
+   * Sort field (defaults to `facility_name`). When `include_potential_targets=true`, only `facility_name`, `system_name`, `city`, and `status` are applicable.
+   */
+  sort?: QueryParamSort | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.CompanyTargetFacility>;
+};
+
+export type ListCompanyTargetFacilitiesResponse = {
+  result: ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk;
+};
+
+/** @internal */
+export const QueryParamStatus$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamStatus
+> = z.nativeEnum(QueryParamStatus);
+
+/** @internal */
+export const HasIndividual$outboundSchema: z.ZodNativeEnum<
+  typeof HasIndividual
+> = z.nativeEnum(HasIndividual);
+
+/** @internal */
+export const HasActiveIndividual$outboundSchema: z.ZodNativeEnum<
+  typeof HasActiveIndividual
+> = z.nativeEnum(HasActiveIndividual);
+
+/** @internal */
+export const IncludePotentialTargets$outboundSchema: z.ZodNativeEnum<
+  typeof IncludePotentialTargets
+> = z.nativeEnum(IncludePotentialTargets);
+
+/** @internal */
+export const QueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamSort
+> = z.nativeEnum(QueryParamSort);
+
+/** @internal */
+export type ListCompanyTargetFacilitiesRequest$Outbound = {
+  company_id: number;
+  expand?: Array<string> | undefined;
+  status?: string | undefined;
+  has_individual?: string | undefined;
+  has_active_individual?: string | undefined;
+  include_potential_targets?: string | undefined;
+  facility_name_like?: string | undefined;
+  city_like?: string | undefined;
+  address_like?: string | undefined;
+  system_name_like?: string | undefined;
+  sort?: string | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+};
+
+/** @internal */
+export const ListCompanyTargetFacilitiesRequest$outboundSchema: z.ZodType<
+  ListCompanyTargetFacilitiesRequest$Outbound,
+  z.ZodTypeDef,
+  ListCompanyTargetFacilitiesRequest
+> = z.object({
+  companyId: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+  status: QueryParamStatus$outboundSchema.optional(),
+  hasIndividual: HasIndividual$outboundSchema.optional(),
+  hasActiveIndividual: HasActiveIndividual$outboundSchema.optional(),
+  includePotentialTargets: IncludePotentialTargets$outboundSchema.optional(),
+  facilityNameLike: z.string().optional(),
+  cityLike: z.string().optional(),
+  addressLike: z.string().optional(),
+  systemNameLike: z.string().optional(),
+  sort: QueryParamSort$outboundSchema.optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    hasIndividual: "has_individual",
+    hasActiveIndividual: "has_active_individual",
+    includePotentialTargets: "include_potential_targets",
+    facilityNameLike: "facility_name_like",
+    cityLike: "city_like",
+    addressLike: "address_like",
+    systemNameLike: "system_name_like",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function listCompanyTargetFacilitiesRequestToJSON(
+  listCompanyTargetFacilitiesRequest: ListCompanyTargetFacilitiesRequest,
+): string {
+  return JSON.stringify(
+    ListCompanyTargetFacilitiesRequest$outboundSchema.parse(
+      listCompanyTargetFacilitiesRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk$inboundSchema:
+  z.ZodType<
+    ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    pager: components.Pager$inboundSchema,
+    items: z.array(components.CompanyTargetFacility$inboundSchema),
+  });
+
+export function listCompanyTargetFacilitiesListCompanyTargetFacilitiesOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCompanyTargetFacilitiesResponse$inboundSchema: z.ZodType<
+  ListCompanyTargetFacilitiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() =>
+    ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listCompanyTargetFacilitiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCompanyTargetFacilitiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListCompanyTargetFacilitiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCompanyTargetFacilitiesResponse' from JSON`,
+  );
+}

package/src/models/operations/listlookupsystems.ts

@@ -9,11 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const Expand = {
+export const QueryParamExpand = {
   SystemFacilities: "system.facilities",
   SystemLocation: "system.location",
 } as const;
-export type Expand = ClosedEnum<typeof Expand>;
+export type QueryParamExpand = ClosedEnum<typeof QueryParamExpand>;
 
 /**
  * Filter systems to those with facilities of the given use type.
@@ -31,7 +31,7 @@ export type ListLookupSystemsRequest = {
   /**
    * Expand values to include in the response. Allowed: `system.facilities`, `system.location`
    */
-  expand?: Array<Expand> | undefined;
+  expand?: Array<QueryParamExpand> | undefined;
   /**
    * Filter systems to those with facilities of the given use type.
    */
@@ -46,8 +46,9 @@ export type ListLookupSystemsResponseBody = {
 };
 
 /** @internal */
-export const Expand$outboundSchema: z.ZodNativeEnum<typeof Expand> = z
-  .nativeEnum(Expand);
+export const QueryParamExpand$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamExpand
+> = z.nativeEnum(QueryParamExpand);
 
 /** @internal */
 export const Use$outboundSchema: z.ZodNativeEnum<typeof Use> = z.nativeEnum(
@@ -66,7 +67,7 @@ export const ListLookupSystemsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListLookupSystemsRequest
 > = z.object({
-  expand: z.array(Expand$outboundSchema).optional(),
+  expand: z.array(QueryParamExpand$outboundSchema).optional(),
   use: Use$outboundSchema.optional(),
 });
 

package/src/models/operations/listorsearchfacilities.ts

@@ -5,11 +5,23 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.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";
 
+/**
+ * For Company Manager callers, filter facilities by whether the manager's company has already targeted them via a `CompanyTargetFacility` link. Only `false` is accepted — restricts the response to same-site facilities the company has not yet targeted (useful when discovering candidate facilities the company could newly target). The facilities a company already targets are available from `GET /api/companies/{company_id}/target-facilities`. Ignored for non-Company-Manager callers.
+ */
+export const Targeted = {
+  False: "false",
+} as const;
+/**
+ * For Company Manager callers, filter facilities by whether the manager's company has already targeted them via a `CompanyTargetFacility` link. Only `false` is accepted — restricts the response to same-site facilities the company has not yet targeted (useful when discovering candidate facilities the company could newly target). The facilities a company already targets are available from `GET /api/companies/{company_id}/target-facilities`. Ignored for non-Company-Manager callers.
+ */
+export type Targeted = ClosedEnum<typeof Targeted>;
+
 export type ListOrSearchFacilitiesRequest = {
   /**
    * A comma-separated list of object attributes to sort on.
@@ -59,6 +71,10 @@ export type ListOrSearchFacilitiesRequest = {
    * The longitude of the current Geo coordinates
    */
   longitude?: number | undefined;
+  /**
+   * For Company Manager callers, filter facilities by whether the manager's company has already targeted them via a `CompanyTargetFacility` link. Only `false` is accepted — restricts the response to same-site facilities the company has not yet targeted (useful when discovering candidate facilities the company could newly target). The facilities a company already targets are available from `GET /api/companies/{company_id}/target-facilities`. Ignored for non-Company-Manager callers.
+   */
+  targeted?: Targeted | undefined;
 };
 
 /**
@@ -76,6 +92,10 @@ export type ListOrSearchFacilitiesResponse = {
   result: ListOrSearchFacilitiesListOrSearchFacilitiesOk;
 };
 
+/** @internal */
+export const Targeted$outboundSchema: z.ZodNativeEnum<typeof Targeted> = z
+  .nativeEnum(Targeted);
+
 /** @internal */
 export type ListOrSearchFacilitiesRequest$Outbound = {
   sort?: string | null | undefined;
@@ -89,6 +109,7 @@ export type ListOrSearchFacilitiesRequest$Outbound = {
   status: string;
   latitude?: number | undefined;
   longitude?: number | undefined;
+  targeted?: string | undefined;
 };
 
 /** @internal */
@@ -108,6 +129,7 @@ export const ListOrSearchFacilitiesRequest$outboundSchema: z.ZodType<
   status: components.ActiveStatus$outboundSchema.default("Active"),
   latitude: z.number().optional(),
   longitude: z.number().optional(),
+  targeted: Targeted$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",

package/src/models/operations/securityzonecheckin.ts

@@ -5,19 +5,22 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { smartUnion } from "../../types/smartUnion.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const RequestBodyExpand = {
+export const SecurityZoneCheckinRequestBodyExpand = {
   VendorScanBadgeData: "vendor_scan.badge_data",
 } as const;
-export type RequestBodyExpand = ClosedEnum<typeof RequestBodyExpand>;
+export type SecurityZoneCheckinRequestBodyExpand = ClosedEnum<
+  typeof SecurityZoneCheckinRequestBodyExpand
+>;
 
-export type SecurityZoneCheckinRequestBody2 = {
+export type RequestBody2 = {
   /**
    * The longitude of the current Geo coordinates
    */
@@ -46,15 +49,13 @@ export type SecurityZoneCheckinRequestBody2 = {
   scanType?: components.ScanType | undefined;
   recheckVendorScanId?: number | undefined;
   temperature?: number | undefined;
-  expand?: Array<RequestBodyExpand> | undefined;
+  expand?: Array<SecurityZoneCheckinRequestBodyExpand> | undefined;
 };
 
-export const SecurityZoneCheckinRequestBodyExpand = {
+export const RequestBodyExpand = {
   VendorScanBadgeData: "vendor_scan.badge_data",
 } as const;
-export type SecurityZoneCheckinRequestBodyExpand = ClosedEnum<
-  typeof SecurityZoneCheckinRequestBodyExpand
->;
+export type RequestBodyExpand = ClosedEnum<typeof RequestBodyExpand>;
 
 export type One = {
   /**
@@ -85,17 +86,16 @@ export type One = {
   scanType?: components.ScanType | undefined;
   recheckVendorScanId?: number | undefined;
   temperature?: number | undefined;
-  expand?: Array<SecurityZoneCheckinRequestBodyExpand> | undefined;
+  expand?: Array<RequestBodyExpand> | undefined;
 };
 
-export type SecurityZoneCheckinRequestBody =
-  | One
-  | SecurityZoneCheckinRequestBody2;
+export type SecurityZoneCheckinRequestBody = One | RequestBody2;
 
 export const Requires = {
   CompleteCheckin: "complete_checkin",
+  AskScreeningQuestions: "ask_screening_questions",
 } as const;
-export type Requires = ClosedEnum<typeof Requires>;
+export type Requires = OpenEnum<typeof Requires>;
 
 export type Handoff = components.Handoff | number;
 
@@ -133,12 +133,13 @@ export type SecurityZoneCheckinSecurityZoneCheckinOk = {
 };
 
 /** @internal */
-export const RequestBodyExpand$outboundSchema: z.ZodNativeEnum<
-  typeof RequestBodyExpand
-> = z.nativeEnum(RequestBodyExpand);
+export const SecurityZoneCheckinRequestBodyExpand$outboundSchema:
+  z.ZodNativeEnum<typeof SecurityZoneCheckinRequestBodyExpand> = z.nativeEnum(
+    SecurityZoneCheckinRequestBodyExpand,
+  );
 
 /** @internal */
-export type SecurityZoneCheckinRequestBody2$Outbound = {
+export type RequestBody2$Outbound = {
   longitude?: number | undefined;
   latitude?: number | undefined;
   qr_code: string;
@@ -162,10 +163,10 @@ export type SecurityZoneCheckinRequestBody2$Outbound = {
 };
 
 /** @internal */
-export const SecurityZoneCheckinRequestBody2$outboundSchema: z.ZodType<
-  SecurityZoneCheckinRequestBody2$Outbound,
+export const RequestBody2$outboundSchema: z.ZodType<
+  RequestBody2$Outbound,
   z.ZodTypeDef,
-  SecurityZoneCheckinRequestBody2
+  RequestBody2
 > = z.object({
   longitude: z.number().optional(),
   latitude: z.number().optional(),
@@ -186,7 +187,8 @@ export const SecurityZoneCheckinRequestBody2$outboundSchema: z.ZodType<
   scanType: components.ScanType$outboundSchema.optional(),
   recheckVendorScanId: z.number().int().optional(),
   temperature: z.number().optional(),
-  expand: z.array(RequestBodyExpand$outboundSchema).optional(),
+  expand: z.array(SecurityZoneCheckinRequestBodyExpand$outboundSchema)
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     qrCode: "qr_code",
@@ -204,21 +206,14 @@ export const SecurityZoneCheckinRequestBody2$outboundSchema: z.ZodType<
   });
 });
 
-export function securityZoneCheckinRequestBody2ToJSON(
-  securityZoneCheckinRequestBody2: SecurityZoneCheckinRequestBody2,
-): string {
-  return JSON.stringify(
-    SecurityZoneCheckinRequestBody2$outboundSchema.parse(
-      securityZoneCheckinRequestBody2,
-    ),
-  );
+export function requestBody2ToJSON(requestBody2: RequestBody2): string {
+  return JSON.stringify(RequestBody2$outboundSchema.parse(requestBody2));
 }
 
 /** @internal */
-export const SecurityZoneCheckinRequestBodyExpand$outboundSchema:
-  z.ZodNativeEnum<typeof SecurityZoneCheckinRequestBodyExpand> = z.nativeEnum(
-    SecurityZoneCheckinRequestBodyExpand,
-  );
+export const RequestBodyExpand$outboundSchema: z.ZodNativeEnum<
+  typeof RequestBodyExpand
+> = z.nativeEnum(RequestBodyExpand);
 
 /** @internal */
 export type One$Outbound = {
@@ -266,8 +261,7 @@ export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
     scanType: components.ScanType$outboundSchema.optional(),
     recheckVendorScanId: z.number().int().optional(),
     temperature: z.number().optional(),
-    expand: z.array(SecurityZoneCheckinRequestBodyExpand$outboundSchema)
-      .optional(),
+    expand: z.array(RequestBodyExpand$outboundSchema).optional(),
   }).transform((v) => {
     return remap$(v, {
       qrCode: "qr_code",
@@ -292,7 +286,7 @@ export function oneToJSON(one: One): string {
 /** @internal */
 export type SecurityZoneCheckinRequestBody$Outbound =
   | One$Outbound
-  | SecurityZoneCheckinRequestBody2$Outbound;
+  | RequestBody2$Outbound;
 
 /** @internal */
 export const SecurityZoneCheckinRequestBody$outboundSchema: z.ZodType<
@@ -301,7 +295,7 @@ export const SecurityZoneCheckinRequestBody$outboundSchema: z.ZodType<
   SecurityZoneCheckinRequestBody
 > = smartUnion([
   z.lazy(() => One$outboundSchema),
-  z.lazy(() => SecurityZoneCheckinRequestBody2$outboundSchema),
+  z.lazy(() => RequestBody2$outboundSchema),
 ]);
 
 export function securityZoneCheckinRequestBodyToJSON(
@@ -315,8 +309,11 @@ export function securityZoneCheckinRequestBodyToJSON(
 }
 
 /** @internal */
-export const Requires$inboundSchema: z.ZodNativeEnum<typeof Requires> = z
-  .nativeEnum(Requires);
+export const Requires$inboundSchema: z.ZodType<
+  Requires,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Requires);
 
 /** @internal */
 export const Handoff$inboundSchema: z.ZodType<Handoff, z.ZodTypeDef, unknown> =