@greensecurity/javascript-sdk 0.44.0-beta.6 → 0.44.0-beta.61

package/src/models/operations/listfacilityvendors.ts

@@ -0,0 +1,310 @@
+/*
+ * 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 ListFacilityVendorsQueryParamStatus = {
+  Approved: "approved",
+  Pending: "pending",
+  Denied: "denied",
+} as const;
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export type ListFacilityVendorsQueryParamStatus = ClosedEnum<
+  typeof ListFacilityVendorsQueryParamStatus
+>;
+
+/**
+ * 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?: ListFacilityVendorsQueryParamStatus | 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 ListFacilityVendorsQueryParamStatus$outboundSchema:
+  z.ZodNativeEnum<typeof ListFacilityVendorsQueryParamStatus> = z.nativeEnum(
+    ListFacilityVendorsQueryParamStatus,
+  );
+
+/** @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: ListFacilityVendorsQueryParamStatus$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`,
+  );
+}

package/src/models/operations/listvendoradditionalfacilityfields.ts

@@ -42,7 +42,7 @@ export type ListVendorAdditionalFacilityFieldsRequest = {
 /**
  * Legacy VendorFieldValue row (deprecated shape).
  */
-export type Items = {
+export type ListVendorAdditionalFacilityFieldsItems = {
   /**
    * VendorFieldValue id
    */
@@ -61,7 +61,7 @@ export type Items = {
  */
 export type ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOk =
   {
-    items: Array<Items>;
+    items: Array<ListVendorAdditionalFacilityFieldsItems>;
     /**
      * Pagination information for a pageable list
      */
@@ -113,22 +113,31 @@ export function listVendorAdditionalFacilityFieldsRequestToJSON(
 }
 
 /** @internal */
-export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
-  .object({
-    id: types.optional(types.number()),
-    system: z.nullable(types.string()).optional(),
-    facility: z.nullable(types.string()).optional(),
-    field: z.nullable(types.string()).optional(),
-    value: z.nullable(types.string()).optional(),
-  });
+export const ListVendorAdditionalFacilityFieldsItems$inboundSchema: z.ZodType<
+  ListVendorAdditionalFacilityFieldsItems,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  system: z.nullable(types.string()).optional(),
+  facility: z.nullable(types.string()).optional(),
+  field: z.nullable(types.string()).optional(),
+  value: z.nullable(types.string()).optional(),
+});
 
-export function itemsFromJSON(
+export function listVendorAdditionalFacilityFieldsItemsFromJSON(
   jsonString: string,
-): SafeParseResult<Items, SDKValidationError> {
+): SafeParseResult<
+  ListVendorAdditionalFacilityFieldsItems,
+  SDKValidationError
+> {
   return safeParse(
     jsonString,
-    (x) => Items$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Items' from JSON`,
+    (x) =>
+      ListVendorAdditionalFacilityFieldsItems$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListVendorAdditionalFacilityFieldsItems' from JSON`,
   );
 }
 
@@ -139,7 +148,9 @@ export const ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityField
     z.ZodTypeDef,
     unknown
   > = z.object({
-    items: z.array(z.lazy(() => Items$inboundSchema)),
+    items: z.array(
+      z.lazy(() => ListVendorAdditionalFacilityFieldsItems$inboundSchema),
+    ),
     pager: components.Pager$inboundSchema,
   });
 

package/src/models/operations/listvendorcredits.ts

@@ -6,6 +6,7 @@ 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";
 
@@ -47,6 +48,10 @@ export type ListVendorCreditsListVendorCreditsOk = {
    * Pagination information for a pageable list
    */
   pager: components.Pager;
+  /**
+   * Current overall balance of the vendor's account (not tied to a specific transaction).
+   */
+  creditBalance: number;
 };
 
 export type ListVendorCreditsResponse = {
@@ -96,6 +101,11 @@ export const ListVendorCreditsListVendorCreditsOk$inboundSchema: z.ZodType<
 > = z.object({
   items: z.array(components.Credit$inboundSchema),
   pager: components.Pager$inboundSchema,
+  credit_balance: types.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "credit_balance": "creditBalance",
+  });
 });
 
 export function listVendorCreditsListVendorCreditsOkFromJSON(

package/src/models/operations/updatesthewebhookendpointwiththegivenid.ts

@@ -11,13 +11,13 @@ export type UpdatesTheWebhookEndpointWithTheGivenIdRequest = {
    * The identifier of the object
    */
   id: number;
-  webhookEndpoint: components.WebhookEndpoint;
+  webhookEndpointUpdate: components.WebhookEndpointUpdate;
 };
 
 /** @internal */
 export type UpdatesTheWebhookEndpointWithTheGivenIdRequest$Outbound = {
   id: number;
-  WebhookEndpoint: components.WebhookEndpoint$Outbound;
+  WebhookEndpointUpdate: components.WebhookEndpointUpdate$Outbound;
 };
 
 /** @internal */
@@ -28,10 +28,10 @@ export const UpdatesTheWebhookEndpointWithTheGivenIdRequest$outboundSchema:
     UpdatesTheWebhookEndpointWithTheGivenIdRequest
   > = z.object({
     id: z.number().int(),
-    webhookEndpoint: components.WebhookEndpoint$outboundSchema,
+    webhookEndpointUpdate: components.WebhookEndpointUpdate$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
-      webhookEndpoint: "WebhookEndpoint",
+      webhookEndpointUpdate: "WebhookEndpointUpdate",
     });
   });
 

package/src/models/operations/updateuser.ts

@@ -38,6 +38,10 @@ export type UpdateUserRequestBody = {
    * Replaces the legacy vendor-side fields `email_recepient` and
    * `send_weekly_summary_email`, which remain on the Vendor object during
    * the migration window but are deprecated.
+   *
+   * `receive_vendor_emails` is company-manager-only and is stored on the
+   * CompanyManager record rather than the User, but is exposed here
+   * alongside the other preferences for a single read/write shape.
    */
   emailPreferences?: components.EmailPreferences | undefined;
 };

package/src/models/operations/updatevendordetails.ts

@@ -82,6 +82,14 @@ export type UpdateVendorDetailsRequestBody = {
    * The vendor's primary department id value to set
    */
   primaryDepartmentId?: number | undefined;
+  /**
+   * The vendor's primary sales state as a 2-letter US state code (e.g. `TX`). Persisted to the vendor's `territory` column.
+   */
+  primarySalesState?: string | undefined;
+  /**
+   * Set to `null` to remove the vendor from its company. Company managers only; this replaces `DELETE /api/vendors/:id/company`. Only `null` is accepted — reassigning the vendor to a different company is not supported through this endpoint.
+   */
+  companyId?: any | null | undefined;
 };
 
 export type UpdateVendorDetailsRequest = {
@@ -112,6 +120,8 @@ export type UpdateVendorDetailsRequestBody$Outbound = {
   location?: components.UserLocation$Outbound | null | undefined;
   supervisor?: components.Supervisor$Outbound | null | undefined;
   primary_department_id?: number | undefined;
+  primary_sales_state?: string | undefined;
+  company_id?: any | null | undefined;
 };
 
 /** @internal */
@@ -127,12 +137,16 @@ export const UpdateVendorDetailsRequestBody$outboundSchema: z.ZodType<
   location: z.nullable(components.UserLocation$outboundSchema).optional(),
   supervisor: z.nullable(components.Supervisor$outboundSchema).optional(),
   primaryDepartmentId: z.number().int().optional(),
+  primarySalesState: z.string().optional(),
+  companyId: z.nullable(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
     qrCode: "qr_code",
     emailRecepient: "email_recepient",
     sendWeeklySummaryEmail: "send_weekly_summary_email",
     primaryDepartmentId: "primary_department_id",
+    primarySalesState: "primary_sales_state",
+    companyId: "company_id",
   });
 });
 

package/src/models/operations/updatevendorpaymentresponsibility.ts

@@ -0,0 +1,159 @@
+/*
+ * 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 UpdateVendorPaymentResponsibilityRequestBody = {
+  /**
+   * User ID responsible for Credentialing Subscription & Expediting payments. Pass `null` to reset responsibility to the vendor.
+   */
+  credentialingSubscriptionUserId?: number | null | undefined;
+  /**
+   * User ID responsible for Initial Hard Badge payments. Pass `null` to reset responsibility to the vendor.
+   */
+  hardBadgeInitialUserId?: number | null | undefined;
+  /**
+   * User ID responsible for Additional Hard Badge payments. Pass `null` to reset responsibility to the vendor.
+   */
+  hardBadgeExtraUserId?: number | null | undefined;
+  /**
+   * User ID responsible for Other Invoice payments. Pass `null` to reset responsibility to the vendor.
+   */
+  otherInvoicesUserId?: number | null | undefined;
+};
+
+export type UpdateVendorPaymentResponsibilityRequest = {
+  /**
+   * ID of the vendor rep.
+   */
+  vendorId: number;
+  requestBody: UpdateVendorPaymentResponsibilityRequestBody;
+};
+
+/**
+ * The request was successful, and the server has returned the updated payment responsibility record.
+ */
+export type UpdateVendorPaymentResponsibilityUpdateVendorPaymentResponsibilityOk =
+  {
+    /**
+     * Records which party (vendor or company manager) is responsible for each
+     *
+     * @remarks
+     * payment category for a given vendor–company relationship. A `null`
+     * `_user_id` field means responsibility defaults to the vendor.
+     */
+    paymentResponsibility?:
+      | components.VendorPaymentResponsibilityAssignments
+      | undefined;
+  };
+
+/** @internal */
+export type UpdateVendorPaymentResponsibilityRequestBody$Outbound = {
+  credentialing_subscription_user_id?: number | null | undefined;
+  hard_badge_initial_user_id?: number | null | undefined;
+  hard_badge_extra_user_id?: number | null | undefined;
+  other_invoices_user_id?: number | null | undefined;
+};
+
+/** @internal */
+export const UpdateVendorPaymentResponsibilityRequestBody$outboundSchema:
+  z.ZodType<
+    UpdateVendorPaymentResponsibilityRequestBody$Outbound,
+    z.ZodTypeDef,
+    UpdateVendorPaymentResponsibilityRequestBody
+  > = z.object({
+    credentialingSubscriptionUserId: z.nullable(z.number().int()).optional(),
+    hardBadgeInitialUserId: z.nullable(z.number().int()).optional(),
+    hardBadgeExtraUserId: z.nullable(z.number().int()).optional(),
+    otherInvoicesUserId: z.nullable(z.number().int()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      credentialingSubscriptionUserId: "credentialing_subscription_user_id",
+      hardBadgeInitialUserId: "hard_badge_initial_user_id",
+      hardBadgeExtraUserId: "hard_badge_extra_user_id",
+      otherInvoicesUserId: "other_invoices_user_id",
+    });
+  });
+
+export function updateVendorPaymentResponsibilityRequestBodyToJSON(
+  updateVendorPaymentResponsibilityRequestBody:
+    UpdateVendorPaymentResponsibilityRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateVendorPaymentResponsibilityRequestBody$outboundSchema.parse(
+      updateVendorPaymentResponsibilityRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateVendorPaymentResponsibilityRequest$Outbound = {
+  vendor_id: number;
+  RequestBody: UpdateVendorPaymentResponsibilityRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateVendorPaymentResponsibilityRequest$outboundSchema: z.ZodType<
+  UpdateVendorPaymentResponsibilityRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateVendorPaymentResponsibilityRequest
+> = z.object({
+  vendorId: z.number().int(),
+  requestBody: z.lazy(() =>
+    UpdateVendorPaymentResponsibilityRequestBody$outboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    vendorId: "vendor_id",
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateVendorPaymentResponsibilityRequestToJSON(
+  updateVendorPaymentResponsibilityRequest:
+    UpdateVendorPaymentResponsibilityRequest,
+): string {
+  return JSON.stringify(
+    UpdateVendorPaymentResponsibilityRequest$outboundSchema.parse(
+      updateVendorPaymentResponsibilityRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const UpdateVendorPaymentResponsibilityUpdateVendorPaymentResponsibilityOk$inboundSchema:
+  z.ZodType<
+    UpdateVendorPaymentResponsibilityUpdateVendorPaymentResponsibilityOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    payment_responsibility: types.optional(
+      components.VendorPaymentResponsibilityAssignments$inboundSchema,
+    ),
+  }).transform((v) => {
+    return remap$(v, {
+      "payment_responsibility": "paymentResponsibility",
+    });
+  });
+
+export function updateVendorPaymentResponsibilityUpdateVendorPaymentResponsibilityOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  UpdateVendorPaymentResponsibilityUpdateVendorPaymentResponsibilityOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UpdateVendorPaymentResponsibilityUpdateVendorPaymentResponsibilityOk$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'UpdateVendorPaymentResponsibilityUpdateVendorPaymentResponsibilityOk' from JSON`,
+  );
+}