@greensecurity/javascript-sdk 0.47.0-beta.9 → 0.48.0-beta.0

package/src/models/operations/getvendortargetfacilities.ts

@@ -7,26 +7,52 @@ 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";
 
 /**
- * Filters to target facilities with this status.
+ * Filters to target facilities with this status. `not_approved` matches every status other than `Approved`, including no status.
  */
 export const GetVendorTargetFacilitiesQueryParamStatus = {
   Pending: "pending",
   Approved: "approved",
   Denied: "denied",
+  NotApproved: "not_approved",
 } as const;
 /**
- * Filters to target facilities with this status.
+ * Filters to target facilities with this status. `not_approved` matches every status other than `Approved`, including no status.
  */
 export type GetVendorTargetFacilitiesQueryParamStatus = ClosedEnum<
   typeof GetVendorTargetFacilitiesQueryParamStatus
 >;
 
 /**
- * The field to sort results by. Defaults to `facility_name`.
+ * When `true`, leaves out target facilities whose facility is not active.
+ */
+export const ActiveFacilitiesOnly = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * When `true`, leaves out target facilities whose facility is not active.
+ */
+export type ActiveFacilitiesOnly = ClosedEnum<typeof ActiveFacilitiesOnly>;
+
+/**
+ * When `true`, the response also includes `status_counts`.
+ */
+export const IncludeStatusCounts = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * When `true`, the response also includes `status_counts`.
+ */
+export type IncludeStatusCounts = ClosedEnum<typeof IncludeStatusCounts>;
+
+/**
+ * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `system_and_facility_name` sorts by system name, then by facility name, and lists facilities without a system last. Both ignore `desc`.
  */
 export const GetVendorTargetFacilitiesQueryParamSort = {
   FacilityName: "facility_name",
@@ -34,9 +60,11 @@ export const GetVendorTargetFacilitiesQueryParamSort = {
   Status: "status",
   QuestionsAnswered: "questions_answered",
   DateCreated: "date_created",
+  NotApprovedFirst: "not_approved_first",
+  SystemAndFacilityName: "system_and_facility_name",
 } as const;
 /**
- * The field to sort results by. Defaults to `facility_name`.
+ * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `system_and_facility_name` sorts by system name, then by facility name, and lists facilities without a system last. Both ignore `desc`.
  */
 export type GetVendorTargetFacilitiesQueryParamSort = ClosedEnum<
   typeof GetVendorTargetFacilitiesQueryParamSort
@@ -62,13 +90,25 @@ export type GetVendorTargetFacilitiesRequest = {
    */
   systemNameLike?: string | undefined;
   /**
-   * Search across facility name and system name.
+   * Search across facility name, street address, city, state (code or full name), ZIP code, and system name.
    */
   searchLike?: string | undefined;
   /**
-   * Filters to target facilities with this status.
+   * Filters to target facilities with this status. `not_approved` matches every status other than `Approved`, including no status.
    */
   status?: GetVendorTargetFacilitiesQueryParamStatus | undefined;
+  /**
+   * Filters to the target facility row of this facility.
+   */
+  facilityId?: number | undefined;
+  /**
+   * When `true`, leaves out target facilities whose facility is not active.
+   */
+  activeFacilitiesOnly?: ActiveFacilitiesOnly | undefined;
+  /**
+   * When `true`, the response also includes `status_counts`.
+   */
+  includeStatusCounts?: IncludeStatusCounts | undefined;
   /**
    * The page number of results to return, starting at 1.
    */
@@ -78,7 +118,7 @@ export type GetVendorTargetFacilitiesRequest = {
    */
   itemsPerPage?: number | undefined;
   /**
-   * The field to sort results by. Defaults to `facility_name`.
+   * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `system_and_facility_name` sorts by system name, then by facility name, and lists facilities without a system last. Both ignore `desc`.
    */
   sort?: GetVendorTargetFacilitiesQueryParamSort | undefined;
   /**
@@ -100,6 +140,10 @@ export type GetVendorTargetFacilitiesGetVendorTargetFacilitiesOk = {
    */
   pager: components.Pager;
   items: Array<components.VendorTargetFacility>;
+  /**
+   * How many of a vendor's target facility rows are approved and not approved. Returned when you pass `include_status_counts=true`.
+   */
+  statusCounts?: components.VendorTargetFacilityStatusCounts | undefined;
 };
 
 export type GetVendorTargetFacilitiesResponse = {
@@ -111,6 +155,16 @@ export const GetVendorTargetFacilitiesQueryParamStatus$outboundSchema:
   z.ZodNativeEnum<typeof GetVendorTargetFacilitiesQueryParamStatus> = z
     .nativeEnum(GetVendorTargetFacilitiesQueryParamStatus);
 
+/** @internal */
+export const ActiveFacilitiesOnly$outboundSchema: z.ZodNativeEnum<
+  typeof ActiveFacilitiesOnly
+> = z.nativeEnum(ActiveFacilitiesOnly);
+
+/** @internal */
+export const IncludeStatusCounts$outboundSchema: z.ZodNativeEnum<
+  typeof IncludeStatusCounts
+> = z.nativeEnum(IncludeStatusCounts);
+
 /** @internal */
 export const GetVendorTargetFacilitiesQueryParamSort$outboundSchema:
   z.ZodNativeEnum<typeof GetVendorTargetFacilitiesQueryParamSort> = z
@@ -123,6 +177,9 @@ export type GetVendorTargetFacilitiesRequest$Outbound = {
   system_name_like?: string | undefined;
   search_like?: string | undefined;
   status?: string | undefined;
+  facility_id?: number | undefined;
+  active_facilities_only?: string | undefined;
+  include_status_counts?: string | undefined;
   page?: number | undefined;
   items_per_page?: number | undefined;
   sort?: string | undefined;
@@ -141,6 +198,9 @@ export const GetVendorTargetFacilitiesRequest$outboundSchema: z.ZodType<
   systemNameLike: z.string().optional(),
   searchLike: z.string().optional(),
   status: GetVendorTargetFacilitiesQueryParamStatus$outboundSchema.optional(),
+  facilityId: z.number().int().optional(),
+  activeFacilitiesOnly: ActiveFacilitiesOnly$outboundSchema.optional(),
+  includeStatusCounts: IncludeStatusCounts$outboundSchema.optional(),
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().optional(),
   sort: GetVendorTargetFacilitiesQueryParamSort$outboundSchema.optional(),
@@ -152,6 +212,9 @@ export const GetVendorTargetFacilitiesRequest$outboundSchema: z.ZodType<
     facilityNameLike: "facility_name_like",
     systemNameLike: "system_name_like",
     searchLike: "search_like",
+    facilityId: "facility_id",
+    activeFacilitiesOnly: "active_facilities_only",
+    includeStatusCounts: "include_status_counts",
     itemsPerPage: "items_per_page",
   });
 });
@@ -175,6 +238,13 @@ export const GetVendorTargetFacilitiesGetVendorTargetFacilitiesOk$inboundSchema:
   > = z.object({
     pager: components.Pager$inboundSchema,
     items: z.array(components.VendorTargetFacility$inboundSchema),
+    status_counts: types.optional(
+      components.VendorTargetFacilityStatusCounts$inboundSchema,
+    ),
+  }).transform((v) => {
+    return remap$(v, {
+      "status_counts": "statusCounts",
+    });
   });
 
 export function getVendorTargetFacilitiesGetVendorTargetFacilitiesOkFromJSON(

package/src/models/operations/updatevendorpaymentresponsibility.ts

@@ -19,11 +19,11 @@ export type UpdateVendorPaymentResponsibilityRequestBody = {
    */
   credentialingSubscriptionUserId?: number | null | undefined;
   /**
-   * User ID responsible for Initial Hard Badge payments. Pass `null` to reset responsibility to the vendor.
+   * User ID responsible for Badges payments (a vendor's first hard badge). 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.
+   * User ID responsible for Replacement Badges payments (any hard badge after the first). Pass `null` to reset responsibility to the vendor.
    */
   hardBadgeExtraUserId?: number | null | undefined;
   /**

package/src/react-query/vendorsGetVendorTargetFacilities.core.ts

@@ -79,6 +79,9 @@ export function buildVendorsGetVendorTargetFacilitiesQuery(
       systemNameLike: request.systemNameLike,
       searchLike: request.searchLike,
       status: request.status,
+      facilityId: request.facilityId,
+      activeFacilitiesOnly: request.activeFacilitiesOnly,
+      includeStatusCounts: request.includeStatusCounts,
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       sort: request.sort,
@@ -129,6 +132,9 @@ export function buildVendorsGetVendorTargetFacilitiesInfiniteQuery(
         systemNameLike: request.systemNameLike,
         searchLike: request.searchLike,
         status: request.status,
+        facilityId: request.facilityId,
+        activeFacilitiesOnly: request.activeFacilitiesOnly,
+        includeStatusCounts: request.includeStatusCounts,
         page: request.page,
         itemsPerPage: request.itemsPerPage,
         sort: request.sort,
@@ -177,6 +183,9 @@ export function queryKeyVendorsGetVendorTargetFacilities(
     systemNameLike?: string | undefined;
     searchLike?: string | undefined;
     status?: operations.GetVendorTargetFacilitiesQueryParamStatus | undefined;
+    facilityId?: number | undefined;
+    activeFacilitiesOnly?: operations.ActiveFacilitiesOnly | undefined;
+    includeStatusCounts?: operations.IncludeStatusCounts | undefined;
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     sort?: operations.GetVendorTargetFacilitiesQueryParamSort | undefined;
@@ -200,6 +209,9 @@ export function queryKeyVendorsGetVendorTargetFacilitiesInfinite(
     systemNameLike?: string | undefined;
     searchLike?: string | undefined;
     status?: operations.GetVendorTargetFacilitiesQueryParamStatus | undefined;
+    facilityId?: number | undefined;
+    activeFacilitiesOnly?: operations.ActiveFacilitiesOnly | undefined;
+    includeStatusCounts?: operations.IncludeStatusCounts | undefined;
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     sort?: operations.GetVendorTargetFacilitiesQueryParamSort | undefined;

package/src/react-query/vendorsGetVendorTargetFacilities.ts

@@ -83,8 +83,12 @@ export type VendorsGetVendorTargetFacilitiesQueryError =
  *
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
+ * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
+ *
+ * Pass `include_status_counts=true` to also receive `status_counts`, the number of approved and not approved rows. The counts honor `active_facilities_only` and `facility_id`, and ignore the search, name, and status filters.
  */
 export function useVendorsGetVendorTargetFacilities(
   request: operations.GetVendorTargetFacilitiesRequest,
@@ -119,8 +123,12 @@ export function useVendorsGetVendorTargetFacilities(
  *
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
+ * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
+ *
+ * Pass `include_status_counts=true` to also receive `status_counts`, the number of approved and not approved rows. The counts honor `active_facilities_only` and `facility_id`, and ignore the search, name, and status filters.
  */
 export function useVendorsGetVendorTargetFacilitiesSuspense(
   request: operations.GetVendorTargetFacilitiesRequest,
@@ -155,8 +163,12 @@ export function useVendorsGetVendorTargetFacilitiesSuspense(
  *
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
+ * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
+ *
+ * Pass `include_status_counts=true` to also receive `status_counts`, the number of approved and not approved rows. The counts honor `active_facilities_only` and `facility_id`, and ignore the search, name, and status filters.
  */
 export function useVendorsGetVendorTargetFacilitiesInfinite(
   request: operations.GetVendorTargetFacilitiesRequest,
@@ -205,8 +217,12 @@ export function useVendorsGetVendorTargetFacilitiesInfinite(
  *
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
+ * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
+ *
+ * Pass `include_status_counts=true` to also receive `status_counts`, the number of approved and not approved rows. The counts honor `active_facilities_only` and `facility_id`, and ignore the search, name, and status filters.
  */
 export function useVendorsGetVendorTargetFacilitiesInfiniteSuspense(
   request: operations.GetVendorTargetFacilitiesRequest,
@@ -252,6 +268,9 @@ export function setVendorsGetVendorTargetFacilitiesData(
       systemNameLike?: string | undefined;
       searchLike?: string | undefined;
       status?: operations.GetVendorTargetFacilitiesQueryParamStatus | undefined;
+      facilityId?: number | undefined;
+      activeFacilitiesOnly?: operations.ActiveFacilitiesOnly | undefined;
+      includeStatusCounts?: operations.IncludeStatusCounts | undefined;
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       sort?: operations.GetVendorTargetFacilitiesQueryParamSort | undefined;
@@ -281,6 +300,9 @@ export function invalidateVendorsGetVendorTargetFacilities(
         status?:
           | operations.GetVendorTargetFacilitiesQueryParamStatus
           | undefined;
+        facilityId?: number | undefined;
+        activeFacilitiesOnly?: operations.ActiveFacilitiesOnly | undefined;
+        includeStatusCounts?: operations.IncludeStatusCounts | undefined;
         page?: number | undefined;
         itemsPerPage?: number | undefined;
         sort?: operations.GetVendorTargetFacilitiesQueryParamSort | undefined;

package/src/react-query/vendorsUpdateVendorDetails.ts

@@ -36,6 +36,7 @@ export type VendorsUpdateVendorDetailsMutationData = boolean;
 
 export type VendorsUpdateVendorDetailsMutationError =
   | errors.ApiErrorResponse
+  | errors.UnprocessableEntityOrValidationError
   | GreenSecurityError
   | ResponseValidationError
   | ConnectionError
@@ -54,12 +55,15 @@ export type VendorsUpdateVendorDetailsMutationError =
  * can also remove the vendor from their company by sending `company_id: null`.
  *
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
- * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
+ * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax` and `personal_email`. The `address` and
  * `country` properties of the shared `UserLocation` schema have no effect here, and
  * updating them is not supported. `state` accepts a US state or a Canadian
  * province—the vendor's country, set only at registration, is not editable
  * through this endpoint.
  *
+ * `location.personal_email` is stored lowercased, and a value that is not a valid
+ * email address, or is longer than 255 characters, gets a `422` response.
+ *
  * Submitting `location.zip` or `location.state` cross-checks the postal code
  * against the resulting state (using the vendor's existing value for whichever
  * of the two you omit from the request). The server rejects a code that is not shaped like a real

package/src/sdk/vendors.ts

@@ -1026,12 +1026,15 @@ export class Vendors extends ClientSDK {
    * can also remove the vendor from their company by sending `company_id: null`.
    *
    * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
-   * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
+   * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax` and `personal_email`. The `address` and
    * `country` properties of the shared `UserLocation` schema have no effect here, and
    * updating them is not supported. `state` accepts a US state or a Canadian
    * province—the vendor's country, set only at registration, is not editable
    * through this endpoint.
    *
+   * `location.personal_email` is stored lowercased, and a value that is not a valid
+   * email address, or is longer than 255 characters, gets a `422` response.
+   *
    * Submitting `location.zip` or `location.state` cross-checks the postal code
    * against the resulting state (using the vendor's existing value for whichever
    * of the two you omit from the request). The server rejects a code that is not shaped like a real
@@ -1503,8 +1506,12 @@ export class Vendors extends ClientSDK {
    *
    * - `vendor_target_facility.facility`
    * - `vendor_target_facility.has_screening_responses`
+   * - `vendor_target_facility.expiring_credential_count`
+   * - `vendor_target_facility.system_logo_url`
    *
    * The endpoint rejects any other value with `422 Unprocessable Entity`.
+   *
+   * Pass `include_status_counts=true` to also receive `status_counts`, the number of approved and not approved rows. The counts honor `active_facilities_only` and `facility_id`, and ignore the search, name, and status filters.
    */
   async getVendorTargetFacilities(
     request: operations.GetVendorTargetFacilitiesRequest,