@greensecurity/javascript-sdk 0.18.0 → 0.18.2

package/src/models/components/invoicetransaction.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Reduced list of attributes of the Invoice transaction record
+ */
+export type InvoiceTransaction = {
+  dateProcessed?: string | null | undefined;
+  payee?: string | null | undefined;
+  amount?: number | null | undefined;
+  creditId?: number | null | undefined;
+  transactionId?: string | null | undefined;
+  success?: boolean | null | undefined;
+  cardLast4?: string | null | undefined;
+};
+
+/** @internal */
+export const InvoiceTransaction$inboundSchema: z.ZodType<
+  InvoiceTransaction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  date_processed: z.nullable(z.string()).optional(),
+  payee: z.nullable(z.string()).optional(),
+  amount: z.nullable(z.number().int()).optional(),
+  credit_id: z.nullable(z.number().int()).optional(),
+  transaction_id: z.nullable(z.string()).optional(),
+  success: z.nullable(z.boolean()).optional(),
+  card_last4: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "date_processed": "dateProcessed",
+    "credit_id": "creditId",
+    "transaction_id": "transactionId",
+    "card_last4": "cardLast4",
+  });
+});
+
+/** @internal */
+export type InvoiceTransaction$Outbound = {
+  date_processed?: string | null | undefined;
+  payee?: string | null | undefined;
+  amount?: number | null | undefined;
+  credit_id?: number | null | undefined;
+  transaction_id?: string | null | undefined;
+  success?: boolean | null | undefined;
+  card_last4?: string | null | undefined;
+};
+
+/** @internal */
+export const InvoiceTransaction$outboundSchema: z.ZodType<
+  InvoiceTransaction$Outbound,
+  z.ZodTypeDef,
+  InvoiceTransaction
+> = z.object({
+  dateProcessed: z.nullable(z.string()).optional(),
+  payee: z.nullable(z.string()).optional(),
+  amount: z.nullable(z.number().int()).optional(),
+  creditId: z.nullable(z.number().int()).optional(),
+  transactionId: z.nullable(z.string()).optional(),
+  success: z.nullable(z.boolean()).optional(),
+  cardLast4: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    dateProcessed: "date_processed",
+    creditId: "credit_id",
+    transactionId: "transaction_id",
+    cardLast4: "card_last4",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InvoiceTransaction$ {
+  /** @deprecated use `InvoiceTransaction$inboundSchema` instead. */
+  export const inboundSchema = InvoiceTransaction$inboundSchema;
+  /** @deprecated use `InvoiceTransaction$outboundSchema` instead. */
+  export const outboundSchema = InvoiceTransaction$outboundSchema;
+  /** @deprecated use `InvoiceTransaction$Outbound` instead. */
+  export type Outbound = InvoiceTransaction$Outbound;
+}
+
+export function invoiceTransactionToJSON(
+  invoiceTransaction: InvoiceTransaction,
+): string {
+  return JSON.stringify(
+    InvoiceTransaction$outboundSchema.parse(invoiceTransaction),
+  );
+}
+
+export function invoiceTransactionFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceTransaction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceTransaction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceTransaction' from JSON`,
+  );
+}

package/src/models/operations/getvendorinvoicedetails.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetVendorInvoiceDetailsRequest = {
+  /**
+   * 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 const GetVendorInvoiceDetailsRequest$inboundSchema: z.ZodType<
+  GetVendorInvoiceDetailsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  expand: z.array(components.Expand$inboundSchema).optional(),
+});
+
+/** @internal */
+export type GetVendorInvoiceDetailsRequest$Outbound = {
+  id: number;
+  expand?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GetVendorInvoiceDetailsRequest$outboundSchema: z.ZodType<
+  GetVendorInvoiceDetailsRequest$Outbound,
+  z.ZodTypeDef,
+  GetVendorInvoiceDetailsRequest
+> = z.object({
+  id: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetVendorInvoiceDetailsRequest$ {
+  /** @deprecated use `GetVendorInvoiceDetailsRequest$inboundSchema` instead. */
+  export const inboundSchema = GetVendorInvoiceDetailsRequest$inboundSchema;
+  /** @deprecated use `GetVendorInvoiceDetailsRequest$outboundSchema` instead. */
+  export const outboundSchema = GetVendorInvoiceDetailsRequest$outboundSchema;
+  /** @deprecated use `GetVendorInvoiceDetailsRequest$Outbound` instead. */
+  export type Outbound = GetVendorInvoiceDetailsRequest$Outbound;
+}
+
+export function getVendorInvoiceDetailsRequestToJSON(
+  getVendorInvoiceDetailsRequest: GetVendorInvoiceDetailsRequest,
+): string {
+  return JSON.stringify(
+    GetVendorInvoiceDetailsRequest$outboundSchema.parse(
+      getVendorInvoiceDetailsRequest,
+    ),
+  );
+}
+
+export function getVendorInvoiceDetailsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetVendorInvoiceDetailsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetVendorInvoiceDetailsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetVendorInvoiceDetailsRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -7,6 +7,7 @@ export * from "./expeditetimeremaining.js";
 export * from "./getfacility.js";
 export * from "./getsupportarticle.js";
 export * from "./getuserbyid.js";
+export * from "./getvendorinvoicedetails.js";
 export * from "./listorsearchfacilities.js";
 export * from "./listorsearchsupportarticles.js";
 export * from "./listvendorcredentials.js";

package/src/models/operations/listorsearchsupportarticles.ts

@@ -26,6 +26,14 @@ export type ListOrSearchSupportArticlesRequest = {
    * Number of items to show in a given page
    */
   itemsPerPage?: number | undefined;
+  /**
+   * Search for objects in the same category as the search string
+   */
+  category?: string | undefined;
+  /**
+   * Search for objects by the search string
+   */
+  search?: string | undefined;
 };
 
 /**
@@ -53,6 +61,8 @@ export const ListOrSearchSupportArticlesRequest$inboundSchema: z.ZodType<
   desc: components.Desc$inboundSchema.optional(),
   page: z.number().int().optional(),
   items_per_page: z.number().int().optional(),
+  category: z.string().optional(),
+  search: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "items_per_page": "itemsPerPage",
@@ -65,6 +75,8 @@ export type ListOrSearchSupportArticlesRequest$Outbound = {
   desc?: components.Desc$Outbound | undefined;
   page?: number | undefined;
   items_per_page?: number | undefined;
+  category?: string | undefined;
+  search?: string | undefined;
 };
 
 /** @internal */
@@ -77,6 +89,8 @@ export const ListOrSearchSupportArticlesRequest$outboundSchema: z.ZodType<
   desc: components.Desc$outboundSchema.optional(),
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().optional(),
+  category: z.string().optional(),
+  search: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",

package/src/react-query/index.ts

@@ -17,6 +17,7 @@ export * from "./usersPassword.js";
 export * from "./usersPasswordResetRequest.js";
 export * from "./vendorsCreateVendorRegistration.js";
 export * from "./vendorsExpediteTimeRemaining.js";
+export * from "./vendorsGetVendorInvoiceDetails.js";
 export * from "./vendorsListVendorCredentials.js";
 export * from "./vendorsListVendorInvoices.js";
 export * from "./vendorsListVendorJobTitles.js";

package/src/react-query/supportArticlesListOrSearchSupportArticles.ts

@@ -198,6 +198,8 @@ export function setSupportArticlesListOrSearchSupportArticlesData(
       desc?: components.Desc | undefined;
       page?: number | undefined;
       itemsPerPage?: number | undefined;
+      category?: string | undefined;
+      search?: string | undefined;
     },
   ],
   data: SupportArticlesListOrSearchSupportArticlesQueryData,
@@ -219,6 +221,8 @@ export function invalidateSupportArticlesListOrSearchSupportArticles(
       desc?: components.Desc | undefined;
       page?: number | undefined;
       itemsPerPage?: number | undefined;
+      category?: string | undefined;
+      search?: string | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
@@ -264,6 +268,8 @@ export function buildSupportArticlesListOrSearchSupportArticlesQuery(
       desc: request.desc,
       page: request.page,
       itemsPerPage: request.itemsPerPage,
+      category: request.category,
+      search: request.search,
     }),
     queryFn: async function supportArticlesListOrSearchSupportArticlesQueryFn(
       ctx,
@@ -302,6 +308,8 @@ export function buildSupportArticlesListOrSearchSupportArticlesInfiniteQuery(
       desc: request.desc,
       page: request.page,
       itemsPerPage: request.itemsPerPage,
+      category: request.category,
+      search: request.search,
     }),
     queryFn: async function supportArticlesListOrSearchSupportArticlesQuery(
       ctx,
@@ -338,6 +346,8 @@ export function queryKeySupportArticlesListOrSearchSupportArticles(
     desc?: components.Desc | undefined;
     page?: number | undefined;
     itemsPerPage?: number | undefined;
+    category?: string | undefined;
+    search?: string | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/vendorsGetVendorInvoiceDetails.ts

@@ -0,0 +1,187 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoiceDetails.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type VendorsGetVendorInvoiceDetailsQueryData = components.Invoice;
+
+/**
+ * Get vendor invoice details
+ *
+ * @remarks
+ * Retrieve an individual vendor invoice detais.
+ *
+ * Available `expand` scopes are:
+ *
+ * invoice.line_items
+ * invoice.invoice_transactions
+ */
+export function useVendorsGetVendorInvoiceDetails(
+  request: operations.GetVendorInvoiceDetailsRequest,
+  options?: QueryHookOptions<VendorsGetVendorInvoiceDetailsQueryData>,
+): UseQueryResult<VendorsGetVendorInvoiceDetailsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsGetVendorInvoiceDetailsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get vendor invoice details
+ *
+ * @remarks
+ * Retrieve an individual vendor invoice detais.
+ *
+ * Available `expand` scopes are:
+ *
+ * invoice.line_items
+ * invoice.invoice_transactions
+ */
+export function useVendorsGetVendorInvoiceDetailsSuspense(
+  request: operations.GetVendorInvoiceDetailsRequest,
+  options?: SuspenseQueryHookOptions<VendorsGetVendorInvoiceDetailsQueryData>,
+): UseSuspenseQueryResult<VendorsGetVendorInvoiceDetailsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsGetVendorInvoiceDetailsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchVendorsGetVendorInvoiceDetails(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorInvoiceDetailsRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetVendorInvoiceDetailsQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsGetVendorInvoiceDetailsData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
+  data: VendorsGetVendorInvoiceDetailsQueryData,
+): VendorsGetVendorInvoiceDetailsQueryData | undefined {
+  const key = queryKeyVendorsGetVendorInvoiceDetails(...queryKeyBase);
+
+  return client.setQueryData<VendorsGetVendorInvoiceDetailsQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorsGetVendorInvoiceDetails(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorInvoiceDetails",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsGetVendorInvoiceDetails(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorInvoiceDetails",
+    ],
+  });
+}
+
+export function buildVendorsGetVendorInvoiceDetailsQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorInvoiceDetailsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetVendorInvoiceDetailsQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorInvoiceDetails(request.id, {
+      expand: request.expand,
+    }),
+    queryFn: async function vendorsGetVendorInvoiceDetailsQueryFn(
+      ctx,
+    ): Promise<VendorsGetVendorInvoiceDetailsQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsGetVendorInvoiceDetails(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsGetVendorInvoiceDetails(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorInvoiceDetails",
+    id,
+    parameters,
+  ];
+}

package/src/sdk/vendors.ts

@@ -4,10 +4,12 @@
 
 import { vendorsCreateVendorRegistration } from "../funcs/vendorsCreateVendorRegistration.js";
 import { vendorsExpediteTimeRemaining } from "../funcs/vendorsExpediteTimeRemaining.js";
+import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoiceDetails.js";
 import { vendorsListVendorCredentials } from "../funcs/vendorsListVendorCredentials.js";
 import { vendorsListVendorInvoices } from "../funcs/vendorsListVendorInvoices.js";
 import { vendorsListVendorJobTitles } from "../funcs/vendorsListVendorJobTitles.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
@@ -107,4 +109,26 @@ export class Vendors extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get vendor invoice details
+   *
+   * @remarks
+   * Retrieve an individual vendor invoice detais.
+   *
+   * Available `expand` scopes are:
+   *
+   * invoice.line_items
+   * invoice.invoice_transactions
+   */
+  async getVendorInvoiceDetails(
+    request: operations.GetVendorInvoiceDetailsRequest,
+    options?: RequestOptions,
+  ): Promise<components.Invoice> {
+    return unwrapAsync(vendorsGetVendorInvoiceDetails(
+      this,
+      request,
+      options,
+    ));
+  }
 }