@greensecurity/javascript-sdk 0.44.0-beta.15 → 0.44.0-beta.16

package/src/funcs/organizationsListCompanyTargetFacilities.ts

@@ -0,0 +1,291 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List company target facilities
+ *
+ * @remarks
+ * Lists the CompanyTargetFacility links for a company — the facilities the
+ * company is targeting. Each row carries the linked facility (with location
+ * and parent system), the link status, and per-facility counts of the
+ * company's individuals targeting it.
+ *
+ * When `include_potential_targets=true`, returns ALL non-deleted facilities
+ * via a LEFT JOIN. Targeted rows carry their CTF `id` and `status`; non-targeted
+ * rows have `id: null` and `status: "Not Targeted"`.
+ *
+ * Access control: the URL's `company_id` must be in the caller's read scope
+ * for Company (a company manager's or vendor's own company, or a company
+ * whose app is activated for the API user). Callers outside that scope
+ * receive `404 Company not found`.
+ *
+ * Filter with `has_individual` / `has_active_individual` to drive the
+ * facility roster views.
+ *
+ * Available `expand` scopes are:
+ *
+ * - company_target_facility.facility
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function organizationsListCompanyTargetFacilities(
+  client: GreenSecurityCore,
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListCompanyTargetFacilitiesResponse,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { page: number }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListCompanyTargetFacilitiesResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListCompanyTargetFacilitiesRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    company_id: encodeSimple("company_id", payload.company_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/companies/{company_id}/target-facilities")(
+    pathParams,
+  );
+
+  const query = queryJoin(
+    encodeFormQuery({
+      "expand": payload.expand,
+    }, { explode: false }),
+    encodeFormQuery({
+      "address_like": payload.address_like,
+      "city_like": payload.city_like,
+      "desc": payload.desc,
+      "facility_name_like": payload.facility_name_like,
+      "has_active_individual": payload.has_active_individual,
+      "has_individual": payload.has_individual,
+      "include_potential_targets": payload.include_potential_targets,
+      "items_per_page": payload.items_per_page,
+      "page": payload.page,
+      "sort": payload.sort,
+      "status": payload.status,
+      "system_name_like": payload.system_name_like,
+    }),
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listCompanyTargetFacilities",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.ListCompanyTargetFacilitiesResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListCompanyTargetFacilitiesResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403, 404, 422], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListCompanyTargetFacilitiesResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
+    const page = request?.page ?? 1;
+    const nextPage = page + 1;
+
+    if (!responseData) {
+      return { next: () => null };
+    }
+    const results = dlv(responseData, "items");
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.itemsPerPage ?? 0;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      organizationsListCompanyTargetFacilities(
+        client,
+        {
+          ...request,
+          page: nextPage,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { page: nextPage } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.43.5",
-  sdkVersion: "0.44.0-beta.15",
+  sdkVersion: "0.44.0-beta.16",
   genVersion: "2.897.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.44.0-beta.15 2.897.1 0.43.5 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.44.0-beta.16 2.897.1 0.43.5 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/companytargetfacility.ts

@@ -0,0 +1,124 @@
+/*
+ * 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 { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Facility, Facility$inboundSchema } from "./facility.js";
+
+/**
+ * The linked facility. Returns the facility ID by default; pass `company_target_facility.facility` to `expand` to receive the full facility object.
+ */
+export type CompanyTargetFacilityFacility = Facility | number;
+
+/**
+ * Per-facility counts of the company's individuals (vendors) currently targeting this facility.
+ */
+export type IndividualCounts = {
+  /**
+   * Total individuals from the company targeting this facility.
+   */
+  total?: number | undefined;
+  /**
+   * Individuals targeting this facility whose credentialing subscription is active.
+   */
+  active?: number | undefined;
+};
+
+/**
+ * Describes the facilities that a company would like to do business with. These are called "target facilities" for the company. A company may target/untarget any number of facilities which will kick off the process of becoming compliant with that facility's vendor policies.
+ */
+export type CompanyTargetFacility = {
+  /**
+   * CompanyTargetFacility row ID. Null when returned via `include_potential_targets=true` for a facility not yet targeted by the company.
+   */
+  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.
+   */
+  facility: Facility | number | null;
+  /**
+   * Link status (Approved, Pending, or Denied). This value is computed by the daily background job from the company's credential state — it is not directly settable through the API.
+   */
+  status: string | null;
+  contracted?: boolean | undefined;
+  dateCreated?: Date | null | undefined;
+  /**
+   * Per-facility counts of the company's individuals (vendors) currently targeting this facility.
+   */
+  individualCounts?: IndividualCounts | null | undefined;
+};
+
+/** @internal */
+export const CompanyTargetFacilityFacility$inboundSchema: z.ZodType<
+  CompanyTargetFacilityFacility,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([Facility$inboundSchema, types.number()]);
+
+export function companyTargetFacilityFacilityFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyTargetFacilityFacility, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyTargetFacilityFacility$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyTargetFacilityFacility' from JSON`,
+  );
+}
+
+/** @internal */
+export const IndividualCounts$inboundSchema: z.ZodType<
+  IndividualCounts,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: types.optional(types.number()),
+  active: types.optional(types.number()),
+});
+
+export function individualCountsFromJSON(
+  jsonString: string,
+): SafeParseResult<IndividualCounts, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IndividualCounts$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IndividualCounts' from JSON`,
+  );
+}
+
+/** @internal */
+export const CompanyTargetFacility$inboundSchema: z.ZodType<
+  CompanyTargetFacility,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.nullable(types.number()),
+  facility: types.nullable(
+    smartUnion([Facility$inboundSchema, types.number()]),
+  ),
+  status: types.nullable(types.string()),
+  contracted: types.optional(types.boolean()),
+  date_created: z.nullable(types.date()).optional(),
+  individual_counts: z.nullable(z.lazy(() => IndividualCounts$inboundSchema))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "date_created": "dateCreated",
+    "individual_counts": "individualCounts",
+  });
+});
+
+export function companyTargetFacilityFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyTargetFacility, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyTargetFacility$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyTargetFacility' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -10,6 +10,7 @@ export * from "./company.js";
 export * from "./companycredentiallistitem.js";
 export * from "./companylookup.js";
 export * from "./companymanager.js";
+export * from "./companytargetfacility.js";
 export * from "./companyvendorfield.js";
 export * from "./companyvendortyperestriction.js";
 export * from "./contact.js";

package/src/models/operations/createcompanytargetfacility.ts

@@ -0,0 +1,132 @@
+/*
+ * 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 CreateCompanyTargetFacilityRequestBody = {
+  /**
+   * The existing facility to target.
+   */
+  facilityId: number;
+};
+
+export type CreateCompanyTargetFacilityRequest = {
+  /**
+   * The company that will target the facility.
+   */
+  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;
+  requestBody: CreateCompanyTargetFacilityRequestBody;
+};
+
+/**
+ * The CompanyTargetFacility link was created.
+ */
+export type CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk = {
+  /**
+   * Describes the facilities that a company would like to do business with. These are called "target facilities" for the company. A company may target/untarget any number of facilities which will kick off the process of becoming compliant with that facility's vendor policies.
+   */
+  companyTargetFacility: components.CompanyTargetFacility;
+};
+
+/** @internal */
+export type CreateCompanyTargetFacilityRequestBody$Outbound = {
+  facility_id: number;
+};
+
+/** @internal */
+export const CreateCompanyTargetFacilityRequestBody$outboundSchema: z.ZodType<
+  CreateCompanyTargetFacilityRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateCompanyTargetFacilityRequestBody
+> = z.object({
+  facilityId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    facilityId: "facility_id",
+  });
+});
+
+export function createCompanyTargetFacilityRequestBodyToJSON(
+  createCompanyTargetFacilityRequestBody:
+    CreateCompanyTargetFacilityRequestBody,
+): string {
+  return JSON.stringify(
+    CreateCompanyTargetFacilityRequestBody$outboundSchema.parse(
+      createCompanyTargetFacilityRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateCompanyTargetFacilityRequest$Outbound = {
+  company_id: number;
+  expand?: Array<string> | undefined;
+  RequestBody: CreateCompanyTargetFacilityRequestBody$Outbound;
+};
+
+/** @internal */
+export const CreateCompanyTargetFacilityRequest$outboundSchema: z.ZodType<
+  CreateCompanyTargetFacilityRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCompanyTargetFacilityRequest
+> = z.object({
+  companyId: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+  requestBody: z.lazy(() =>
+    CreateCompanyTargetFacilityRequestBody$outboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    requestBody: "RequestBody",
+  });
+});
+
+export function createCompanyTargetFacilityRequestToJSON(
+  createCompanyTargetFacilityRequest: CreateCompanyTargetFacilityRequest,
+): string {
+  return JSON.stringify(
+    CreateCompanyTargetFacilityRequest$outboundSchema.parse(
+      createCompanyTargetFacilityRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk$inboundSchema:
+  z.ZodType<
+    CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    company_target_facility: components.CompanyTargetFacility$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "company_target_facility": "companyTargetFacility",
+    });
+  });
+
+export function createCompanyTargetFacilityCreateCompanyTargetFacilityOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk' from JSON`,
+  );
+}

package/src/models/operations/deletecompanytargetfacility.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type DeleteCompanyTargetFacilityRequest = {
+  /**
+   * The company that owns the CompanyTargetFacility link.
+   */
+  companyId: number;
+  /**
+   * CompanyTargetFacility id
+   */
+  id: number;
+};
+
+/** @internal */
+export type DeleteCompanyTargetFacilityRequest$Outbound = {
+  company_id: number;
+  id: number;
+};
+
+/** @internal */
+export const DeleteCompanyTargetFacilityRequest$outboundSchema: z.ZodType<
+  DeleteCompanyTargetFacilityRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteCompanyTargetFacilityRequest
+> = z.object({
+  companyId: z.number().int(),
+  id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+  });
+});
+
+export function deleteCompanyTargetFacilityRequestToJSON(
+  deleteCompanyTargetFacilityRequest: DeleteCompanyTargetFacilityRequest,
+): string {
+  return JSON.stringify(
+    DeleteCompanyTargetFacilityRequest$outboundSchema.parse(
+      deleteCompanyTargetFacilityRequest,
+    ),
+  );
+}