@greensecurity/javascript-sdk 0.43.1-beta.78 → 0.43.1-beta.82

package/src/models/components/expand.ts

@@ -25,27 +25,29 @@ export const Expand = {
   FacilityVendorPolicy: "facility.vendor_policy",
   FacilityVisitorPolicy: "facility.visitor_policy",
   FacilityWorkflow: "facility.workflow",
-  VendorUser: "vendor.user",
-  VendorVendorType: "vendor.vendor_type",
-  VendorVendorJob: "vendor.vendor_job",
-  VendorPaymentProfile: "vendor.payment_profile",
+  VendorApprovedCalendaringFacilities: "vendor.approved_calendaring_facilities",
+  VendorBackgroundCheckDateExpires: "vendor.background_check_date_expires",
+  VendorBadgeDetails: "vendor.badge_details",
+  VendorCompany: "vendor.company",
+  VendorCredentialingSubscription: "vendor.credentialing_subscription",
+  VendorCreditBalance: "vendor.credit_balance",
+  VendorHasCredentialedFacilities: "vendor.has_credentialed_facilities",
+  VendorHasEmeraldStatus: "vendor.has_emerald_status",
   VendorImageUrls: "vendor.image_urls",
   VendorPrimaryFacility: "vendor.primary_facility",
   VendorPrimaryDepartment: "vendor.primary_department",
-  VendorCompany: "vendor.company",
-  VendorCredentialingSubscription: "vendor.credentialing_subscription",
   VendorScrubsSubscription: "vendor.scrubs_subscription",
+  VendorPaymentProfile: "vendor.payment_profile",
   VendorPaymentResponsibility: "vendor.payment_responsibility",
-  VendorBackgroundCheckDateExpires: "vendor.background_check_date_expires",
-  VendorCreditBalance: "vendor.credit_balance",
+  VendorPendingInvoice: "vendor.pending_invoice",
   VendorRegistrationData: "vendor.registration_data",
   VendorRegistrationFinished: "vendor.registration_finished",
+  VendorRequiredBadgeType: "vendor.required_badge_type",
   VendorTargetFacilities: "vendor.target_facilities",
-  VendorApprovedCalendaringFacilities: "vendor.approved_calendaring_facilities",
-  VendorPendingInvoice: "vendor.pending_invoice",
+  VendorUser: "vendor.user",
   VendorVendorGroups: "vendor.vendor_groups",
-  VendorHasCredentialedFacilities: "vendor.has_credentialed_facilities",
-  VendorHasEmeraldStatus: "vendor.has_emerald_status",
+  VendorVendorJob: "vendor.vendor_job",
+  VendorVendorType: "vendor.vendor_type",
   SupportArticleDescription: "support_article.description",
   SupportArticlePublished: "support_article.published",
   SupportArticleNotes: "support_article.notes",

package/src/models/components/vendor.ts

@@ -32,6 +32,11 @@ import {
 } from "./vendorjobtitle.js";
 import { VendorType, VendorType$inboundSchema } from "./vendortype.js";
 
+export type Badge = {
+  badgeType?: string | undefined;
+  requiredBadgeType?: string | null | undefined;
+};
+
 export type One = {
   id?: number | undefined;
   firstName?: string | null | undefined;
@@ -119,6 +124,7 @@ export type PendingInvoice = Invoice | number;
  */
 export type Vendor = {
   id?: number | undefined;
+  badge?: Badge | null | undefined;
   emailRecepient?: string | null | undefined;
   sendWeeklySummaryEmail?: boolean | null | undefined;
   title?: string | null | undefined;
@@ -183,6 +189,28 @@ export type Vendor = {
   targetFacilitiesUpdated?: string | null | undefined;
 };
 
+/** @internal */
+export const Badge$inboundSchema: z.ZodType<Badge, z.ZodTypeDef, unknown> = z
+  .object({
+    badge_type: types.optional(types.string()),
+    required_badge_type: z.nullable(types.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "badge_type": "badgeType",
+      "required_badge_type": "requiredBadgeType",
+    });
+  });
+
+export function badgeFromJSON(
+  jsonString: string,
+): SafeParseResult<Badge, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Badge$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Badge' from JSON`,
+  );
+}
+
 /** @internal */
 export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
   .object({
@@ -492,6 +520,7 @@ export function pendingInvoiceFromJSON(
 export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
   .object({
     id: types.optional(types.number()),
+    badge: z.nullable(z.lazy(() => Badge$inboundSchema)).optional(),
     email_recepient: z.nullable(types.string()).optional(),
     send_weekly_summary_email: z.nullable(types.boolean()).optional(),
     title: z.nullable(types.string()).optional(),

package/src/models/operations/getfacility.ts

@@ -3,17 +3,23 @@
  */
 
 import * as z from "zod/v3";
+import * as components from "../components/index.js";
 
 export type GetFacilityRequest = {
   /**
    * The identifier of the object
    */
   id: 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;
 };
 
 /** @internal */
 export type GetFacilityRequest$Outbound = {
   id: number;
+  expand?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -23,6 +29,7 @@ export const GetFacilityRequest$outboundSchema: z.ZodType<
   GetFacilityRequest
 > = z.object({
   id: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
 });
 
 export function getFacilityRequestToJSON(

package/src/models/operations/listinvoices.ts

@@ -44,9 +44,12 @@ export type ListInvoicesRequest = {
    */
   representative?: string | undefined;
   /**
-   * Filter by a specific authorized vendor ID.
+   * For vendors, "me" or the vendor ID to scope the request.
+   *
+   * @remarks
+   * For API users, the vendor ID (integer) to filter by.
    */
-  vendorId?: number | undefined;
+  vendorId?: string | undefined;
   /**
    * Filter by a specific authorized company ID.
    */
@@ -86,7 +89,7 @@ export type ListInvoicesRequest$Outbound = {
   invoice_number?: string | undefined;
   invoice_financial_status?: string | undefined;
   representative?: string | undefined;
-  vendor_id?: number | undefined;
+  vendor_id?: string | undefined;
   company_id?: number | undefined;
   facility_id?: number | undefined;
   system_id?: number | undefined;
@@ -107,7 +110,7 @@ export const ListInvoicesRequest$outboundSchema: z.ZodType<
   invoiceFinancialStatus: components.InvoiceFinancialStatus$outboundSchema
     .optional(),
   representative: z.string().optional(),
-  vendorId: z.number().int().optional(),
+  vendorId: z.string().optional(),
   companyId: z.number().int().optional(),
   facilityId: z.number().int().optional(),
   systemId: z.number().int().optional(),

package/src/models/operations/listorsearchfacilities.ts

@@ -50,7 +50,7 @@ export type ListOrSearchFacilitiesRequest = {
    *
    * > NOTE: There may be times where it makes sense to show only active objects, active and inactive, or deleted. Some objects may have a separate property for `visible` which should override this state.
    */
-  activeStatus?: components.ActiveStatus | undefined;
+  status?: components.ActiveStatus | undefined;
   /**
    * The latitude of the current Geo coordinates
    */
@@ -86,7 +86,7 @@ export type ListOrSearchFacilitiesRequest$Outbound = {
   system_id?: number | undefined;
   name_like?: string | undefined;
   state_like?: string | undefined;
-  active_status: string;
+  status: string;
   latitude?: number | undefined;
   longitude?: number | undefined;
 };
@@ -105,7 +105,7 @@ export const ListOrSearchFacilitiesRequest$outboundSchema: z.ZodType<
   systemId: z.number().int().optional(),
   nameLike: z.string().optional(),
   stateLike: z.string().optional(),
-  activeStatus: components.ActiveStatus$outboundSchema.default("Active"),
+  status: components.ActiveStatus$outboundSchema.default("Active"),
   latitude: z.number().optional(),
   longitude: z.number().optional(),
 }).transform((v) => {
@@ -114,7 +114,6 @@ export const ListOrSearchFacilitiesRequest$outboundSchema: z.ZodType<
     systemId: "system_id",
     nameLike: "name_like",
     stateLike: "state_like",
-    activeStatus: "active_status",
   });
 });
 

package/src/models/operations/listvendorcredentials.ts

@@ -31,6 +31,10 @@ export type ListVendorCredentialsRequest = {
    * Search by credential status (Pending Approval, Declined, Expired...)
    */
   credentialStatus?: components.CredentialStatus | undefined;
+  /**
+   * A partial string to search in the object name. Do not include any wildcard characters. Searches are not case-sensitive by default.
+   */
+  nameLike?: string | undefined;
   /**
    * The ID associated with a medical facility
    */
@@ -94,6 +98,7 @@ export type ListVendorCredentialsRequest$Outbound = {
   page?: number | undefined;
   items_per_page?: number | undefined;
   credential_status?: string | undefined;
+  name_like?: string | undefined;
   facility_id?: number | null | undefined;
   include_vc?: number | undefined;
   include_cc?: number | undefined;
@@ -113,6 +118,7 @@ export const ListVendorCredentialsRequest$outboundSchema: z.ZodType<
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().optional(),
   credentialStatus: components.CredentialStatus$outboundSchema.optional(),
+  nameLike: z.string().optional(),
   facilityId: z.nullable(z.number()).optional(),
   includeVc: z.number().optional(),
   includeCc: z.number().optional(),
@@ -123,6 +129,7 @@ export const ListVendorCredentialsRequest$outboundSchema: z.ZodType<
   return remap$(v, {
     itemsPerPage: "items_per_page",
     credentialStatus: "credential_status",
+    nameLike: "name_like",
     facilityId: "facility_id",
     includeVc: "include_vc",
     includeCc: "include_cc",

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

@@ -174,7 +174,7 @@ export function queryKeyInvoicesListInvoices(
     invoiceNumber?: string | undefined;
     invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
     representative?: string | undefined;
-    vendorId?: number | undefined;
+    vendorId?: string | undefined;
     companyId?: number | undefined;
     facilityId?: number | undefined;
     systemId?: number | undefined;
@@ -198,7 +198,7 @@ export function queryKeyInvoicesListInvoicesInfinite(
     invoiceNumber?: string | undefined;
     invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
     representative?: string | undefined;
-    vendorId?: number | undefined;
+    vendorId?: string | undefined;
     companyId?: number | undefined;
     facilityId?: number | undefined;
     systemId?: number | undefined;

package/src/react-query/invoicesListInvoices.ts

@@ -69,6 +69,13 @@ export {
  * - invoice.custom_fields
  * - invoice.invoice_type
  * - invoice.may_pay_invoice
+ *
+ * Available `sort` values are:
+ * - id (default)
+ * - invoice_number
+ * - date (processed date)
+ * - financial_status
+ * - amount
  */
 export function useInvoicesListInvoices(
   request: operations.ListInvoicesRequest,
@@ -105,6 +112,13 @@ export function useInvoicesListInvoices(
  * - invoice.custom_fields
  * - invoice.invoice_type
  * - invoice.may_pay_invoice
+ *
+ * Available `sort` values are:
+ * - id (default)
+ * - invoice_number
+ * - date (processed date)
+ * - financial_status
+ * - amount
  */
 export function useInvoicesListInvoicesSuspense(
   request: operations.ListInvoicesRequest,
@@ -141,6 +155,13 @@ export function useInvoicesListInvoicesSuspense(
  * - invoice.custom_fields
  * - invoice.invoice_type
  * - invoice.may_pay_invoice
+ *
+ * Available `sort` values are:
+ * - id (default)
+ * - invoice_number
+ * - date (processed date)
+ * - financial_status
+ * - amount
  */
 export function useInvoicesListInvoicesInfinite(
   request: operations.ListInvoicesRequest,
@@ -194,6 +215,13 @@ export function useInvoicesListInvoicesInfinite(
  * - invoice.custom_fields
  * - invoice.invoice_type
  * - invoice.may_pay_invoice
+ *
+ * Available `sort` values are:
+ * - id (default)
+ * - invoice_number
+ * - date (processed date)
+ * - financial_status
+ * - amount
  */
 export function useInvoicesListInvoicesInfiniteSuspense(
   request: operations.ListInvoicesRequest,
@@ -241,7 +269,7 @@ export function setInvoicesListInvoicesData(
       invoiceNumber?: string | undefined;
       invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
       representative?: string | undefined;
-      vendorId?: number | undefined;
+      vendorId?: string | undefined;
       companyId?: number | undefined;
       facilityId?: number | undefined;
       systemId?: number | undefined;
@@ -266,7 +294,7 @@ export function invalidateInvoicesListInvoices(
       invoiceNumber?: string | undefined;
       invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
       representative?: string | undefined;
-      vendorId?: number | undefined;
+      vendorId?: string | undefined;
       companyId?: number | undefined;
       facilityId?: number | undefined;
       systemId?: number | undefined;

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

@@ -42,7 +42,9 @@ export function buildOrganizationsGetFacilityQuery(
   ) => Promise<OrganizationsGetFacilityQueryData>;
 } {
   return {
-    queryKey: queryKeyOrganizationsGetFacility(request.id),
+    queryKey: queryKeyOrganizationsGetFacility(request.id, {
+      expand: request.expand,
+    }),
     queryFn: async function organizationsGetFacilityQueryFn(
       ctx,
     ): Promise<OrganizationsGetFacilityQueryData> {
@@ -66,6 +68,15 @@ export function buildOrganizationsGetFacilityQuery(
   };
 }
 
-export function queryKeyOrganizationsGetFacility(id: number): QueryKey {
-  return ["@greensecurity/javascript-sdk", "organizations", "getFacility", id];
+export function queryKeyOrganizationsGetFacility(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "getFacility",
+    id,
+    parameters,
+  ];
 }

package/src/react-query/organizationsGetFacility.ts

@@ -10,6 +10,7 @@ import {
   useSuspenseQuery,
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { useGreenSecurityContext } from "./_context.js";
 import {
@@ -74,7 +75,10 @@ export function useOrganizationsGetFacilitySuspense(
 
 export function setOrganizationsGetFacilityData(
   client: QueryClient,
-  queryKeyBase: [id: number],
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
   data: OrganizationsGetFacilityQueryData,
 ): OrganizationsGetFacilityQueryData | undefined {
   const key = queryKeyOrganizationsGetFacility(...queryKeyBase);
@@ -84,7 +88,9 @@ export function setOrganizationsGetFacilityData(
 
 export function invalidateOrganizationsGetFacility(
   client: QueryClient,
-  queryKeyBase: TupleToPrefixes<[id: number]>,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({

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

@@ -84,7 +84,7 @@ export function buildOrganizationsListOrSearchFacilitiesQuery(
       systemId: request.systemId,
       nameLike: request.nameLike,
       stateLike: request.stateLike,
-      activeStatus: request.activeStatus,
+      status: request.status,
       latitude: request.latitude,
       longitude: request.longitude,
     }),
@@ -134,7 +134,7 @@ export function buildOrganizationsListOrSearchFacilitiesInfiniteQuery(
       systemId: request.systemId,
       nameLike: request.nameLike,
       stateLike: request.stateLike,
-      activeStatus: request.activeStatus,
+      status: request.status,
       latitude: request.latitude,
       longitude: request.longitude,
     }),
@@ -182,7 +182,7 @@ export function queryKeyOrganizationsListOrSearchFacilities(
     systemId?: number | undefined;
     nameLike?: string | undefined;
     stateLike?: string | undefined;
-    activeStatus?: components.ActiveStatus | undefined;
+    status?: components.ActiveStatus | undefined;
     latitude?: number | undefined;
     longitude?: number | undefined;
   },
@@ -205,7 +205,7 @@ export function queryKeyOrganizationsListOrSearchFacilitiesInfinite(
     systemId?: number | undefined;
     nameLike?: string | undefined;
     stateLike?: string | undefined;
-    activeStatus?: components.ActiveStatus | undefined;
+    status?: components.ActiveStatus | undefined;
     latitude?: number | undefined;
     longitude?: number | undefined;
   },

package/src/react-query/organizationsListOrSearchFacilities.ts

@@ -237,7 +237,7 @@ export function setOrganizationsListOrSearchFacilitiesData(
       systemId?: number | undefined;
       nameLike?: string | undefined;
       stateLike?: string | undefined;
-      activeStatus?: components.ActiveStatus | undefined;
+      status?: components.ActiveStatus | undefined;
       latitude?: number | undefined;
       longitude?: number | undefined;
     },
@@ -264,7 +264,7 @@ export function invalidateOrganizationsListOrSearchFacilities(
       systemId?: number | undefined;
       nameLike?: string | undefined;
       stateLike?: string | undefined;
-      activeStatus?: components.ActiveStatus | undefined;
+      status?: components.ActiveStatus | undefined;
       latitude?: number | undefined;
       longitude?: number | undefined;
     }]

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

@@ -80,6 +80,7 @@ export function buildVendorsListVendorCredentialsQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       credentialStatus: request.credentialStatus,
+      nameLike: request.nameLike,
       facilityId: request.facilityId,
       includeVc: request.includeVc,
       includeCc: request.includeCc,
@@ -129,6 +130,7 @@ export function buildVendorsListVendorCredentialsInfiniteQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       credentialStatus: request.credentialStatus,
+      nameLike: request.nameLike,
       facilityId: request.facilityId,
       includeVc: request.includeVc,
       includeCc: request.includeCc,
@@ -177,6 +179,7 @@ export function queryKeyVendorsListVendorCredentials(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     credentialStatus?: components.CredentialStatus | undefined;
+    nameLike?: string | undefined;
     facilityId?: number | null | undefined;
     includeVc?: number | undefined;
     includeCc?: number | undefined;
@@ -201,6 +204,7 @@ export function queryKeyVendorsListVendorCredentialsInfinite(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     credentialStatus?: components.CredentialStatus | undefined;
+    nameLike?: string | undefined;
     facilityId?: number | null | undefined;
     includeVc?: number | undefined;
     includeCc?: number | undefined;

package/src/react-query/vendorsListVendorCredentials.ts

@@ -181,6 +181,7 @@ export function setVendorsListVendorCredentialsData(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       credentialStatus?: components.CredentialStatus | undefined;
+      nameLike?: string | undefined;
       facilityId?: number | null | undefined;
       includeVc?: number | undefined;
       includeCc?: number | undefined;
@@ -206,6 +207,7 @@ export function invalidateVendorsListVendorCredentials(
         page?: number | undefined;
         itemsPerPage?: number | undefined;
         credentialStatus?: components.CredentialStatus | undefined;
+        nameLike?: string | undefined;
         facilityId?: number | null | undefined;
         includeVc?: number | undefined;
         includeCc?: number | undefined;

package/src/react-query/vendorsListVendorInvoices.ts

@@ -53,12 +53,16 @@ export {
  * List vendor invoices
  *
  * @remarks
- * List invoices for Vendors
+ * List invoices for Vendors.
+ *
+ * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
  * Available `expand` scopes are:
  *
  * invoice.line_items
  * invoice.may_pay_invoice
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorInvoices(
   request: operations.ListVendorInvoicesRequest,
@@ -79,12 +83,16 @@ export function useVendorsListVendorInvoices(
  * List vendor invoices
  *
  * @remarks
- * List invoices for Vendors
+ * List invoices for Vendors.
+ *
+ * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
  * Available `expand` scopes are:
  *
  * invoice.line_items
  * invoice.may_pay_invoice
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorInvoicesSuspense(
   request: operations.ListVendorInvoicesRequest,
@@ -105,12 +113,16 @@ export function useVendorsListVendorInvoicesSuspense(
  * List vendor invoices
  *
  * @remarks
- * List invoices for Vendors
+ * List invoices for Vendors.
+ *
+ * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
  * Available `expand` scopes are:
  *
  * invoice.line_items
  * invoice.may_pay_invoice
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorInvoicesInfinite(
   request: operations.ListVendorInvoicesRequest,
@@ -150,12 +162,16 @@ export function useVendorsListVendorInvoicesInfinite(
  * List vendor invoices
  *
  * @remarks
- * List invoices for Vendors
+ * List invoices for Vendors.
+ *
+ * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
  * Available `expand` scopes are:
  *
  * invoice.line_items
  * invoice.may_pay_invoice
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorInvoicesInfiniteSuspense(
   request: operations.ListVendorInvoicesRequest,

package/src/sdk/invoices.ts

@@ -32,6 +32,13 @@ export class Invoices extends ClientSDK {
    * - invoice.custom_fields
    * - invoice.invoice_type
    * - invoice.may_pay_invoice
+   *
+   * Available `sort` values are:
+   * - id (default)
+   * - invoice_number
+   * - date (processed date)
+   * - financial_status
+   * - amount
    */
   async listInvoices(
     request: operations.ListInvoicesRequest,

package/src/sdk/vendors.ts

@@ -524,12 +524,16 @@ export class Vendors extends ClientSDK {
    * List vendor invoices
    *
    * @remarks
-   * List invoices for Vendors
+   * List invoices for Vendors.
+   *
+   * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
    *
    * Available `expand` scopes are:
    *
    * invoice.line_items
    * invoice.may_pay_invoice
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async listVendorInvoices(
     request: operations.ListVendorInvoicesRequest,