@greensecurity/javascript-sdk 0.44.0-beta.13 → 0.44.0-beta.14

package/src/admin-funcs/vendorGetPaymentForm.ts

@@ -0,0 +1,6 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+export function vendorGetPaymentForm(): internalApiResult {
+  return new APIPromise($doGetSingle("/vendors/me/payment_form", {}));
+}

package/src/funcs/organizationsListFacilityVendors.ts

@@ -0,0 +1,279 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, encodeSimple } 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 vendors targeting a facility
+ *
+ * @remarks
+ * Powers the Company Portal → Facility Details page. Returns the
+ * paginated list of company-scoped vendor reps that are targeting the
+ * given facility, with each row carrying the rep's name + email, their
+ * last visit to this facility, their facility access status, and any
+ * company custom fields the company has flagged `show_to_vendor` (which
+ * is where the "Employee ID" column on the UI lives).
+ *
+ * Filtering: pass `status=approved|pending|denied` to scope the rows to a
+ * single status tab. Pass `search=<term>` for a single search box that
+ * matches first name, last name, full name, email, OR any visible custom
+ * field value (covering the "search by name / email / Employee ID"
+ * requirement).
+ *
+ * Access control:
+ *   * Regular users: the URL's `:id` must be in the caller's read scope for
+ *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+ *     soft-deleted facilities return `404 Facility not found`.
+ *   * API users: must pass `company_id`. Both the company and the facility
+ *     must be activated for the caller's marketplace app
+ *     (`MarketplaceAppActivation`).
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function organizationsListFacilityVendors(
+  client: GreenSecurityCore,
+  request: operations.ListFacilityVendorsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListFacilityVendorsResponse,
+      | 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.ListFacilityVendorsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListFacilityVendorsResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListFacilityVendorsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/facilities/{id}/vendors")(pathParams);
+
+  const query = encodeFormQuery({
+    "company_id": payload.company_id,
+    "desc": payload.desc,
+    "items_per_page": payload.items_per_page,
+    "page": payload.page,
+    "search": payload.search,
+    "sort": payload.sort,
+    "status": payload.status,
+  });
+
+  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: "listFacilityVendors",
+    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.ListFacilityVendorsResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListFacilityVendorsResponse$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.ListFacilityVendorsResponse,
+        | 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 = () =>
+      organizationsListFacilityVendors(
+        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/index.extras.ts

@@ -29,10 +29,12 @@ import { submitPassword } from "./admin-funcs/registerPassword.js";
 import { submitGeneralInfo } from "./admin-funcs/registerGeneralInfo.js";
 import { submitCompany } from "./admin-funcs/registerCompanies.js";
 
-import {smartBadgePairBadge} from "./admin-funcs/smartBadgePairBadge.js";
-import {smartBadgeUnpairBadge} from "./admin-funcs/smartBadgeUnpairBadge.js";
+import { smartBadgePairBadge } from "./admin-funcs/smartBadgePairBadge.js";
+import { smartBadgeUnpairBadge } from "./admin-funcs/smartBadgeUnpairBadge.js";
 
 import { notifyVendorCredentialFileUploaded } from "./admin-funcs/notifyVendorCredentialFileUploaded.js";
+import { companyManagerGetPaymentForm } from "./admin-funcs/companyManagerGetPaymentForm.js";
+import { vendorGetPaymentForm } from "./admin-funcs/vendorGetPaymentForm.js";
 
 export const __internal = {
   getInternalCore,
@@ -74,7 +76,7 @@ export const __internal = {
     submitGeneralInfo,
     submitCompany
   },
-  
+
   smartBadge: {
     pairBadge: smartBadgePairBadge,
     unpairBadge: smartBadgeUnpairBadge
@@ -82,5 +84,13 @@ export const __internal = {
 
   vendorCredentialFile: {
     notifyUploaded: notifyVendorCredentialFileUploaded
+  },
+
+  companyManager: {
+    getPaymentForm: companyManagerGetPaymentForm,
+  },
+
+  vendor: {
+    getPaymentForm: vendorGetPaymentForm,
   }
 };

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.13",
+  sdkVersion: "0.44.0-beta.14",
   genVersion: "2.897.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.44.0-beta.13 2.897.1 0.43.5 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.44.0-beta.14 2.897.1 0.43.5 @greensecurity/javascript-sdk",
 } as const;

package/src/models/operations/exportcompanytargetfacilities.ts

@@ -14,7 +14,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * Filter by link status.
  */
-export const QueryParamStatus = {
+export const ExportCompanyTargetFacilitiesQueryParamStatus = {
   Pending: "pending",
   Approved: "approved",
   Denied: "denied",
@@ -22,7 +22,9 @@ export const QueryParamStatus = {
 /**
  * Filter by link status.
  */
-export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
+export type ExportCompanyTargetFacilitiesQueryParamStatus = ClosedEnum<
+  typeof ExportCompanyTargetFacilitiesQueryParamStatus
+>;
 
 /**
  * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
@@ -81,7 +83,7 @@ export type ExportCompanyTargetFacilitiesRequest = {
   /**
    * Filter by link status.
    */
-  status?: QueryParamStatus | undefined;
+  status?: ExportCompanyTargetFacilitiesQueryParamStatus | undefined;
   /**
    * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
    */
@@ -127,9 +129,9 @@ export type ExportCompanyTargetFacilitiesResponseBody = {
 };
 
 /** @internal */
-export const QueryParamStatus$outboundSchema: z.ZodNativeEnum<
-  typeof QueryParamStatus
-> = z.nativeEnum(QueryParamStatus);
+export const ExportCompanyTargetFacilitiesQueryParamStatus$outboundSchema:
+  z.ZodNativeEnum<typeof ExportCompanyTargetFacilitiesQueryParamStatus> = z
+    .nativeEnum(ExportCompanyTargetFacilitiesQueryParamStatus);
 
 /** @internal */
 export const HasIndividual$outboundSchema: z.ZodNativeEnum<
@@ -181,7 +183,8 @@ export const ExportCompanyTargetFacilitiesRequest$outboundSchema: z.ZodType<
   ExportCompanyTargetFacilitiesRequest
 > = z.object({
   companyId: z.number().int(),
-  status: QueryParamStatus$outboundSchema.optional(),
+  status: ExportCompanyTargetFacilitiesQueryParamStatus$outboundSchema
+    .optional(),
   hasIndividual: HasIndividual$outboundSchema.optional(),
   hasActiveIndividual: HasActiveIndividual$outboundSchema.optional(),
   facilityNameLike: z.string().optional(),

package/src/models/operations/index.ts

@@ -70,6 +70,7 @@ export * from "./listallwebhookendpoints.js";
 export * from "./listcompanycredentials.js";
 export * from "./listcompanycredits.js";
 export * from "./listcompanymanagers.js";
+export * from "./listfacilityvendors.js";
 export * from "./listfeed.js";
 export * from "./listinvoices.js";
 export * from "./listlocations.js";

package/src/models/operations/listfacilityvendors.ts

@@ -0,0 +1,307 @@
+/*
+ * 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 { ClosedEnum, OpenEnum } 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";
+
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export const QueryParamStatus = {
+  Approved: "approved",
+  Pending: "pending",
+  Denied: "denied",
+} as const;
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
+
+/**
+ * Sort field. Defaults to `name`.
+ */
+export const ListFacilityVendorsQueryParamSort = {
+  Id: "id",
+  Name: "name",
+  LastName: "last_name",
+  Email: "email",
+  Status: "status",
+} as const;
+/**
+ * Sort field. Defaults to `name`.
+ */
+export type ListFacilityVendorsQueryParamSort = ClosedEnum<
+  typeof ListFacilityVendorsQueryParamSort
+>;
+
+export type ListFacilityVendorsRequest = {
+  /**
+   * The facility whose vendor roster to list.
+   */
+  id: number;
+  /**
+   * API users only — the company whose vendors to list. Ignored for company managers / vendors (resolved from the session).
+   */
+  companyId?: number | undefined;
+  /**
+   * Filter rows to a single facility access status. Omit for "All".
+   */
+  status?: QueryParamStatus | undefined;
+  /**
+   * Single search term applied case-insensitively across first name,
+   *
+   * @remarks
+   * last name, full name, email, and any company custom-field value the
+   * vendor has set for a field flagged `show_to_vendor`.
+   */
+  search?: string | 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;
+  /**
+   * Sort field. Defaults to `name`.
+   */
+  sort?: ListFacilityVendorsQueryParamSort | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+};
+
+/**
+ * Facility access status from `target_facilities.status`.
+ */
+export const ListFacilityVendorsStatus = {
+  Approved: "Approved",
+  Pending: "Pending",
+  Denied: "Denied",
+} as const;
+/**
+ * Facility access status from `target_facilities.status`.
+ */
+export type ListFacilityVendorsStatus = OpenEnum<
+  typeof ListFacilityVendorsStatus
+>;
+
+export type CustomFields = {
+  id?: number | undefined;
+  name?: string | undefined;
+  value?: string | null | undefined;
+};
+
+export type Items = {
+  /**
+   * Vendor ID.
+   */
+  id?: number | undefined;
+  /**
+   * Vendor's full name (`first_name + last_name`).
+   */
+  name?: string | null | undefined;
+  /**
+   * Vendor's email.
+   */
+  email?: string | null | undefined;
+  /**
+   * Thumbnail URL for the vendor's head shot.
+   */
+  imageUrl?: string | null | undefined;
+  /**
+   * ISO8601 timestamp of the vendor's most recent scan at this facility, or null if they have never visited.
+   */
+  lastVisit?: string | null | undefined;
+  /**
+   * Facility access status from `target_facilities.status`.
+   */
+  status?: ListFacilityVendorsStatus | null | undefined;
+  /**
+   * Company custom fields flagged `show_to_vendor`. One entry per enabled field; `value` is null when the vendor has no value set.
+   */
+  customFields?: Array<CustomFields> | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListFacilityVendorsListFacilityVendorsOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<Items>;
+};
+
+export type ListFacilityVendorsResponse = {
+  result: ListFacilityVendorsListFacilityVendorsOk;
+};
+
+/** @internal */
+export const QueryParamStatus$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamStatus
+> = z.nativeEnum(QueryParamStatus);
+
+/** @internal */
+export const ListFacilityVendorsQueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof ListFacilityVendorsQueryParamSort
+> = z.nativeEnum(ListFacilityVendorsQueryParamSort);
+
+/** @internal */
+export type ListFacilityVendorsRequest$Outbound = {
+  id: number;
+  company_id?: number | undefined;
+  status?: string | undefined;
+  search?: string | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  sort?: string | undefined;
+  desc?: components.Desc$Outbound | undefined;
+};
+
+/** @internal */
+export const ListFacilityVendorsRequest$outboundSchema: z.ZodType<
+  ListFacilityVendorsRequest$Outbound,
+  z.ZodTypeDef,
+  ListFacilityVendorsRequest
+> = z.object({
+  id: z.number().int(),
+  companyId: z.number().int().optional(),
+  status: QueryParamStatus$outboundSchema.optional(),
+  search: z.string().optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  sort: ListFacilityVendorsQueryParamSort$outboundSchema.optional(),
+  desc: components.Desc$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function listFacilityVendorsRequestToJSON(
+  listFacilityVendorsRequest: ListFacilityVendorsRequest,
+): string {
+  return JSON.stringify(
+    ListFacilityVendorsRequest$outboundSchema.parse(listFacilityVendorsRequest),
+  );
+}
+
+/** @internal */
+export const ListFacilityVendorsStatus$inboundSchema: z.ZodType<
+  ListFacilityVendorsStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListFacilityVendorsStatus);
+
+/** @internal */
+export const CustomFields$inboundSchema: z.ZodType<
+  CustomFields,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  name: types.optional(types.string()),
+  value: z.nullable(types.string()).optional(),
+});
+
+export function customFieldsFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomFields, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomFields$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomFields' from JSON`,
+  );
+}
+
+/** @internal */
+export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.optional(types.number()),
+    name: z.nullable(types.string()).optional(),
+    email: z.nullable(types.string()).optional(),
+    image_url: z.nullable(types.string()).optional(),
+    last_visit: z.nullable(types.string()).optional(),
+    status: z.nullable(ListFacilityVendorsStatus$inboundSchema).optional(),
+    custom_fields: types.optional(
+      z.array(z.lazy(() => CustomFields$inboundSchema)),
+    ),
+  }).transform((v) => {
+    return remap$(v, {
+      "image_url": "imageUrl",
+      "last_visit": "lastVisit",
+      "custom_fields": "customFields",
+    });
+  });
+
+export function itemsFromJSON(
+  jsonString: string,
+): SafeParseResult<Items, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Items$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Items' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListFacilityVendorsListFacilityVendorsOk$inboundSchema: z.ZodType<
+  ListFacilityVendorsListFacilityVendorsOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(z.lazy(() => Items$inboundSchema)),
+});
+
+export function listFacilityVendorsListFacilityVendorsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListFacilityVendorsListFacilityVendorsOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListFacilityVendorsListFacilityVendorsOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListFacilityVendorsListFacilityVendorsOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListFacilityVendorsResponse$inboundSchema: z.ZodType<
+  ListFacilityVendorsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListFacilityVendorsListFacilityVendorsOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listFacilityVendorsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListFacilityVendorsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListFacilityVendorsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListFacilityVendorsResponse' from JSON`,
+  );
+}