@greensecurity/javascript-sdk 0.48.0-beta.1 → 0.48.0-beta.3

package/src/models/components/invoice.ts

@@ -137,6 +137,10 @@ export type Invoice = {
    * Date of the invoice payment. Backfilled automatically by a daily background job for every paid invoice, from the last successful payment transaction or, failing that, the invoice's line item start date or creation date. Unlike `date_processed`, this is reliably populated for real (non-test) payments—allow up to 24 hours for it to appear after payment.
    */
   datePaid?: string | null | undefined;
+  /**
+   * When the invoice was created.
+   */
+  dateCreated?: string | null | undefined;
   /**
    * The date the invoice payment is due. `null` if no due date is set.
    */
@@ -388,6 +392,7 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
     tracking_number: z.nullable(types.string()).optional(),
     date_processed: z.nullable(types.string()).optional(),
     date_paid: z.nullable(types.string()).optional(),
+    date_created: z.nullable(types.string()).optional(),
     date_due: z.nullable(types.string()).optional(),
     amount: z.nullable(types.number()).optional(),
     status: z.nullable(types.string()).optional(),
@@ -415,6 +420,7 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
       "tracking_number": "trackingNumber",
       "date_processed": "dateProcessed",
       "date_paid": "datePaid",
+      "date_created": "dateCreated",
       "date_due": "dateDue",
       "financial_status": "financialStatus",
       "amount_not_paid": "amountNotPaid",
@@ -432,6 +438,7 @@ export type Invoice$Outbound = {
   tracking_number?: string | null | undefined;
   date_processed?: string | null | undefined;
   date_paid?: string | null | undefined;
+  date_created?: string | null | undefined;
   date_due?: string | null | undefined;
   amount?: number | null | undefined;
   status?: string | null | undefined;
@@ -463,6 +470,7 @@ export const Invoice$outboundSchema: z.ZodType<
   trackingNumber: z.nullable(z.string()).optional(),
   dateProcessed: z.nullable(z.string()).optional(),
   datePaid: z.nullable(z.string()).optional(),
+  dateCreated: z.nullable(z.string()).optional(),
   dateDue: z.nullable(z.string()).optional(),
   amount: z.nullable(z.number().int()).optional(),
   status: z.nullable(z.string()).optional(),
@@ -489,6 +497,7 @@ export const Invoice$outboundSchema: z.ZodType<
     trackingNumber: "tracking_number",
     dateProcessed: "date_processed",
     datePaid: "date_paid",
+    dateCreated: "date_created",
     dateDue: "date_due",
     financialStatus: "financial_status",
     amountNotPaid: "amount_not_paid",

package/src/models/components/invoicefinancialstatus.ts

@@ -8,6 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 export const InvoiceFinancialStatus = {
   Paid: "paid",
   Unpaid: "unpaid",
+  AwaitingPayment: "awaiting_payment",
 } as const;
 export type InvoiceFinancialStatus = ClosedEnum<typeof InvoiceFinancialStatus>;
 

package/src/models/operations/getvendorinvoicereceipt.ts

@@ -5,15 +5,32 @@
 import * as z from "zod/v3";
 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * `receipt` (default) includes the payment transactions. `invoice` leaves them out and adds the created and due dates.
+ */
+export const PdfType = {
+  Receipt: "receipt",
+  Invoice: "invoice",
+} as const;
+/**
+ * `receipt` (default) includes the payment transactions. `invoice` leaves them out and adds the created and due dates.
+ */
+export type PdfType = ClosedEnum<typeof PdfType>;
+
 export type GetVendorInvoiceReceiptRequest = {
   /**
    * The identifier of the object.
    */
   id: number;
+  /**
+   * `receipt` (default) includes the payment transactions. `invoice` leaves them out and adds the created and due dates.
+   */
+  pdfType?: PdfType | undefined;
 };
 
 /**
@@ -34,9 +51,14 @@ export type GetVendorInvoiceReceiptGetVendorInvoiceReceiptOk = {
   contentType?: string | undefined;
 };
 
+/** @internal */
+export const PdfType$outboundSchema: z.ZodNativeEnum<typeof PdfType> = z
+  .nativeEnum(PdfType);
+
 /** @internal */
 export type GetVendorInvoiceReceiptRequest$Outbound = {
   id: number;
+  pdf_type?: string | undefined;
 };
 
 /** @internal */
@@ -46,6 +68,11 @@ export const GetVendorInvoiceReceiptRequest$outboundSchema: z.ZodType<
   GetVendorInvoiceReceiptRequest
 > = z.object({
   id: z.number().int(),
+  pdfType: PdfType$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pdfType: "pdf_type",
+  });
 });
 
 export function getVendorInvoiceReceiptRequestToJSON(

package/src/models/operations/invoicesexport.ts

@@ -8,14 +8,15 @@ import { ClosedEnum } from "../../types/enums.js";
 import * as components from "../components/index.js";
 
 /**
- * Filter by financial status (`paid` or `unpaid`).
+ * Filter by financial status (`paid`, `unpaid`, or `awaiting_payment` for pending and overdue).
  */
 export const InvoiceFinancialStatus = {
   Paid: "paid",
   Unpaid: "unpaid",
+  AwaitingPayment: "awaiting_payment",
 } as const;
 /**
- * Filter by financial status (`paid` or `unpaid`).
+ * Filter by financial status (`paid`, `unpaid`, or `awaiting_payment` for pending and overdue).
  */
 export type InvoiceFinancialStatus = ClosedEnum<typeof InvoiceFinancialStatus>;
 
@@ -25,7 +26,7 @@ export type InvoicesExportRequest = {
    */
   invoiceNumber?: string | undefined;
   /**
-   * Filter by financial status (`paid` or `unpaid`).
+   * Filter by financial status (`paid`, `unpaid`, or `awaiting_payment` for pending and overdue).
    */
   invoiceFinancialStatus?: InvoiceFinancialStatus | undefined;
   /**

package/src/models/operations/listalerts.ts

@@ -47,6 +47,10 @@ export type ListAlertsRequest = {
    * Filter alerts by client type. Use `all` to return every alert, or `mobile` to exclude web-only alerts.
    */
   alertType?: AlertType | undefined;
+  /**
+   * Also return visit checkout reminders that were dismissed because the vendor checked out, extended, or got a later reminder. Their `alert_context.dismissed` is `true`.
+   */
+  includeDismissedReminders?: boolean | undefined;
 };
 
 /**
@@ -76,6 +80,7 @@ export type ListAlertsRequest$Outbound = {
   items_per_page?: number | undefined;
   user_id_or_me?: string | undefined;
   alert_type?: string | undefined;
+  include_dismissed_reminders?: boolean | undefined;
 };
 
 /** @internal */
@@ -90,11 +95,13 @@ export const ListAlertsRequest$outboundSchema: z.ZodType<
   itemsPerPage: z.number().int().optional(),
   userIdOrMe: z.string().optional(),
   alertType: AlertType$outboundSchema.optional(),
+  includeDismissedReminders: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",
     userIdOrMe: "user_id_or_me",
     alertType: "alert_type",
+    includeDismissedReminders: "include_dismissed_reminders",
   });
 });
 

package/src/models/operations/listinvoices.ts

@@ -36,7 +36,7 @@ export type ListInvoicesRequest = {
    */
   invoiceNumber?: string | undefined;
   /**
-   * Filter invoices by financial status.
+   * Filter invoices by financial status. `awaiting_payment` matches pending and overdue invoices.
    */
   invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
   /**

package/src/models/operations/listvendorinvoices.ts

@@ -46,7 +46,7 @@ export type ListVendorInvoicesRequest = {
    */
   invoiceNumber?: string | undefined;
   /**
-   * Filter invoices by financial status.
+   * Filter invoices by financial status. `awaiting_payment` matches pending and overdue invoices.
    */
   invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
 };

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

@@ -79,6 +79,7 @@ export function buildAlertsListAlertsQuery(
       itemsPerPage: request.itemsPerPage,
       userIdOrMe: request.userIdOrMe,
       alertType: request.alertType,
+      includeDismissedReminders: request.includeDismissedReminders,
     }),
     queryFn: async function alertsListAlertsQueryFn(
       ctx,
@@ -121,6 +122,7 @@ export function buildAlertsListAlertsInfiniteQuery(
       itemsPerPage: request.itemsPerPage,
       userIdOrMe: request.userIdOrMe,
       alertType: request.alertType,
+      includeDismissedReminders: request.includeDismissedReminders,
     }),
     queryFn: async function alertsListAlertsQuery(
       ctx,
@@ -160,6 +162,7 @@ export function queryKeyAlertsListAlerts(
     itemsPerPage?: number | undefined;
     userIdOrMe?: string | undefined;
     alertType?: operations.AlertType | undefined;
+    includeDismissedReminders?: boolean | undefined;
   },
 ): QueryKey {
   return ["@greensecurity/javascript-sdk", "alerts", "listAlerts", parameters];
@@ -173,6 +176,7 @@ export function queryKeyAlertsListAlertsInfinite(
     itemsPerPage?: number | undefined;
     userIdOrMe?: string | undefined;
     alertType?: operations.AlertType | undefined;
+    includeDismissedReminders?: boolean | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/alertsListAlerts.ts

@@ -210,6 +210,7 @@ export function setAlertsListAlertsData(
       itemsPerPage?: number | undefined;
       userIdOrMe?: string | undefined;
       alertType?: operations.AlertType | undefined;
+      includeDismissedReminders?: boolean | undefined;
     },
   ],
   data: AlertsListAlertsQueryData,
@@ -229,6 +230,7 @@ export function invalidateAlertsListAlerts(
       itemsPerPage?: number | undefined;
       userIdOrMe?: string | undefined;
       alertType?: operations.AlertType | undefined;
+      includeDismissedReminders?: boolean | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,

package/src/react-query/invoicesListInvoices.ts

@@ -101,6 +101,7 @@ export type InvoicesListInvoicesQueryError =
  * - invoice_number
  * - date (processed date)
  * - date_paid
+ * - date_created
  * - financial_status
  * - amount
  */
@@ -155,6 +156,7 @@ export function useInvoicesListInvoices(
  * - invoice_number
  * - date (processed date)
  * - date_paid
+ * - date_created
  * - financial_status
  * - amount
  */
@@ -209,6 +211,7 @@ export function useInvoicesListInvoicesSuspense(
  * - invoice_number
  * - date (processed date)
  * - date_paid
+ * - date_created
  * - financial_status
  * - amount
  */
@@ -277,6 +280,7 @@ export function useInvoicesListInvoicesInfinite(
  * - invoice_number
  * - date (processed date)
  * - date_paid
+ * - date_created
  * - financial_status
  * - amount
  */

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

@@ -42,7 +42,9 @@ export function buildVendorsGetVendorInvoiceReceiptQuery(
   ) => Promise<VendorsGetVendorInvoiceReceiptQueryData>;
 } {
   return {
-    queryKey: queryKeyVendorsGetVendorInvoiceReceipt(request.id),
+    queryKey: queryKeyVendorsGetVendorInvoiceReceipt(request.id, {
+      pdfType: request.pdfType,
+    }),
     queryFn: async function vendorsGetVendorInvoiceReceiptQueryFn(
       ctx,
     ): Promise<VendorsGetVendorInvoiceReceiptQueryData> {
@@ -66,11 +68,15 @@ export function buildVendorsGetVendorInvoiceReceiptQuery(
   };
 }
 
-export function queryKeyVendorsGetVendorInvoiceReceipt(id: number): QueryKey {
+export function queryKeyVendorsGetVendorInvoiceReceipt(
+  id: number,
+  parameters: { pdfType?: operations.PdfType | undefined },
+): QueryKey {
   return [
     "@greensecurity/javascript-sdk",
     "vendors",
     "getVendorInvoiceReceipt",
     id,
+    parameters,
   ];
 }

package/src/react-query/vendorsGetVendorInvoiceReceipt.ts

@@ -112,7 +112,10 @@ export function useVendorsGetVendorInvoiceReceiptSuspense(
 
 export function setVendorsGetVendorInvoiceReceiptData(
   client: QueryClient,
-  queryKeyBase: [id: number],
+  queryKeyBase: [
+    id: number,
+    parameters: { pdfType?: operations.PdfType | undefined },
+  ],
   data: VendorsGetVendorInvoiceReceiptQueryData,
 ): VendorsGetVendorInvoiceReceiptQueryData | undefined {
   const key = queryKeyVendorsGetVendorInvoiceReceipt(...queryKeyBase);
@@ -125,7 +128,9 @@ export function setVendorsGetVendorInvoiceReceiptData(
 
 export function invalidateVendorsGetVendorInvoiceReceipt(
   client: QueryClient,
-  queryKeyBase: TupleToPrefixes<[id: number]>,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { pdfType?: operations.PdfType | undefined }]
+  >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({

package/src/sdk/invoices.ts

@@ -76,6 +76,7 @@ export class Invoices extends ClientSDK {
    * - invoice_number
    * - date (processed date)
    * - date_paid
+   * - date_created
    * - financial_status
    * - amount
    */