@greensecurity/javascript-sdk 0.44.0-beta.2 → 0.44.0-beta.20

package/src/models/operations/listcompanycredentials.ts

@@ -0,0 +1,195 @@
+/*
+ * 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";
+
+export const ListCompanyCredentialsQueryParamSort = {
+  CredentialName: "credential_name",
+  Status: "status",
+  DateExpires: "date_expires",
+} as const;
+export type ListCompanyCredentialsQueryParamSort = ClosedEnum<
+  typeof ListCompanyCredentialsQueryParamSort
+>;
+
+export const ListCompanyCredentialsQueryParamStatus = {
+  PendingVendor: "Pending Vendor",
+  PendingApproval: "Pending Approval",
+  Approved: "Approved",
+  Declined: "Declined",
+  Denied: "Denied",
+  Expired: "Expired",
+  Suspended: "Suspended",
+  PendingClassification: "Pending Classification",
+} as const;
+export type ListCompanyCredentialsQueryParamStatus = ClosedEnum<
+  typeof ListCompanyCredentialsQueryParamStatus
+>;
+
+export const Expand = {
+  VendorCredentialSystems: "vendor_credential.systems",
+} as const;
+export type Expand = ClosedEnum<typeof Expand>;
+
+export type ListCompanyCredentialsRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  /**
+   * 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;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  sort?: ListCompanyCredentialsQueryParamSort | undefined;
+  credentialNameLike?: string | undefined;
+  status?: ListCompanyCredentialsQueryParamStatus | undefined;
+  /**
+   * Filter by credential expiry date on or before this date (YYYY-MM-DD).
+   */
+  dateExpiresLte?: string | undefined;
+  expand?: Array<Expand> | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListCompanyCredentialsListCompanyCredentialsOk = {
+  items: Array<components.CompanyCredentialListItem>;
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+};
+
+export type ListCompanyCredentialsResponse = {
+  result: ListCompanyCredentialsListCompanyCredentialsOk;
+};
+
+/** @internal */
+export const ListCompanyCredentialsQueryParamSort$outboundSchema:
+  z.ZodNativeEnum<typeof ListCompanyCredentialsQueryParamSort> = z.nativeEnum(
+    ListCompanyCredentialsQueryParamSort,
+  );
+
+/** @internal */
+export const ListCompanyCredentialsQueryParamStatus$outboundSchema:
+  z.ZodNativeEnum<typeof ListCompanyCredentialsQueryParamStatus> = z.nativeEnum(
+    ListCompanyCredentialsQueryParamStatus,
+  );
+
+/** @internal */
+export const Expand$outboundSchema: z.ZodNativeEnum<typeof Expand> = z
+  .nativeEnum(Expand);
+
+/** @internal */
+export type ListCompanyCredentialsRequest$Outbound = {
+  id: number;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  sort?: string | undefined;
+  credential_name_like?: string | undefined;
+  status?: string | undefined;
+  date_expires_lte?: string | undefined;
+  expand?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ListCompanyCredentialsRequest$outboundSchema: z.ZodType<
+  ListCompanyCredentialsRequest$Outbound,
+  z.ZodTypeDef,
+  ListCompanyCredentialsRequest
+> = z.object({
+  id: z.number().int(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  sort: ListCompanyCredentialsQueryParamSort$outboundSchema.optional(),
+  credentialNameLike: z.string().optional(),
+  status: ListCompanyCredentialsQueryParamStatus$outboundSchema.optional(),
+  dateExpiresLte: z.string().optional(),
+  expand: z.array(Expand$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    credentialNameLike: "credential_name_like",
+    dateExpiresLte: "date_expires_lte",
+  });
+});
+
+export function listCompanyCredentialsRequestToJSON(
+  listCompanyCredentialsRequest: ListCompanyCredentialsRequest,
+): string {
+  return JSON.stringify(
+    ListCompanyCredentialsRequest$outboundSchema.parse(
+      listCompanyCredentialsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListCompanyCredentialsListCompanyCredentialsOk$inboundSchema:
+  z.ZodType<
+    ListCompanyCredentialsListCompanyCredentialsOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    items: z.array(components.CompanyCredentialListItem$inboundSchema),
+    pager: components.Pager$inboundSchema,
+  });
+
+export function listCompanyCredentialsListCompanyCredentialsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListCompanyCredentialsListCompanyCredentialsOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListCompanyCredentialsListCompanyCredentialsOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListCompanyCredentialsListCompanyCredentialsOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCompanyCredentialsResponse$inboundSchema: z.ZodType<
+  ListCompanyCredentialsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() =>
+    ListCompanyCredentialsListCompanyCredentialsOk$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listCompanyCredentialsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCompanyCredentialsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCompanyCredentialsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCompanyCredentialsResponse' from JSON`,
+  );
+}

package/src/models/operations/listcompanycredits.ts

@@ -15,7 +15,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * Field to sort results by.
  */
-export const QueryParamSort = {
+export const ListCompanyCreditsQueryParamSort = {
   Id: "id",
   Date: "date",
   Action: "action",
@@ -26,7 +26,9 @@ export const QueryParamSort = {
 /**
  * Field to sort results by.
  */
-export type QueryParamSort = ClosedEnum<typeof QueryParamSort>;
+export type ListCompanyCreditsQueryParamSort = ClosedEnum<
+  typeof ListCompanyCreditsQueryParamSort
+>;
 
 export type ListCompanyCreditsRequest = {
   /**
@@ -36,7 +38,7 @@ export type ListCompanyCreditsRequest = {
   /**
    * Field to sort results by.
    */
-  sort?: QueryParamSort | undefined;
+  sort?: ListCompanyCreditsQueryParamSort | undefined;
   /**
    * Sort desc
    */
@@ -109,9 +111,9 @@ export type ListCompanyCreditsResponse = {
 };
 
 /** @internal */
-export const QueryParamSort$outboundSchema: z.ZodNativeEnum<
-  typeof QueryParamSort
-> = z.nativeEnum(QueryParamSort);
+export const ListCompanyCreditsQueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof ListCompanyCreditsQueryParamSort
+> = z.nativeEnum(ListCompanyCreditsQueryParamSort);
 
 /** @internal */
 export type ListCompanyCreditsRequest$Outbound = {
@@ -130,7 +132,7 @@ export const ListCompanyCreditsRequest$outboundSchema: z.ZodType<
   ListCompanyCreditsRequest
 > = z.object({
   id: z.number().int(),
-  sort: QueryParamSort$outboundSchema.optional(),
+  sort: ListCompanyCreditsQueryParamSort$outboundSchema.optional(),
   desc: components.Desc$outboundSchema.optional(),
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().optional(),

package/src/models/operations/listcompanytargetfacilities.ts

@@ -0,0 +1,293 @@
+/*
+ * 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 ListCompanyTargetFacilitiesQueryParamStatus = {
+  Pending: "pending",
+  Approved: "approved",
+  Denied: "denied",
+} as const;
+/**
+ * Filter by link status.
+ */
+export type ListCompanyTargetFacilitiesQueryParamStatus = ClosedEnum<
+  typeof ListCompanyTargetFacilitiesQueryParamStatus
+>;
+
+/**
+ * `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?: ListCompanyTargetFacilitiesQueryParamStatus | 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 ListCompanyTargetFacilitiesQueryParamStatus$outboundSchema:
+  z.ZodNativeEnum<typeof ListCompanyTargetFacilitiesQueryParamStatus> = z
+    .nativeEnum(ListCompanyTargetFacilitiesQueryParamStatus);
+
+/** @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: ListCompanyTargetFacilitiesQueryParamStatus$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`,
+  );
+}