@greensecurity/javascript-sdk 0.37.14 → 0.39.1

package/src/models/operations/getvendorinvoicereceipt.ts

@@ -0,0 +1,165 @@
+/*
+ * 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";
+
+export type GetVendorInvoiceReceiptRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+};
+
+/**
+ * PDF invoice returned as a base64 string inside a JSON object.
+ */
+export type GetVendorInvoiceReceiptResponseBody = {
+  /**
+   * The PDF document encoded as a base64 string.
+   */
+  base64Pdf: string;
+  /**
+   * Suggested filename for the PDF.
+   */
+  filename?: string | undefined;
+  /**
+   * MIME type of the PDF.
+   */
+  contentType?: string | undefined;
+};
+
+/** @internal */
+export const GetVendorInvoiceReceiptRequest$inboundSchema: z.ZodType<
+  GetVendorInvoiceReceiptRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+});
+
+/** @internal */
+export type GetVendorInvoiceReceiptRequest$Outbound = {
+  id: number;
+};
+
+/** @internal */
+export const GetVendorInvoiceReceiptRequest$outboundSchema: z.ZodType<
+  GetVendorInvoiceReceiptRequest$Outbound,
+  z.ZodTypeDef,
+  GetVendorInvoiceReceiptRequest
+> = z.object({
+  id: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetVendorInvoiceReceiptRequest$ {
+  /** @deprecated use `GetVendorInvoiceReceiptRequest$inboundSchema` instead. */
+  export const inboundSchema = GetVendorInvoiceReceiptRequest$inboundSchema;
+  /** @deprecated use `GetVendorInvoiceReceiptRequest$outboundSchema` instead. */
+  export const outboundSchema = GetVendorInvoiceReceiptRequest$outboundSchema;
+  /** @deprecated use `GetVendorInvoiceReceiptRequest$Outbound` instead. */
+  export type Outbound = GetVendorInvoiceReceiptRequest$Outbound;
+}
+
+export function getVendorInvoiceReceiptRequestToJSON(
+  getVendorInvoiceReceiptRequest: GetVendorInvoiceReceiptRequest,
+): string {
+  return JSON.stringify(
+    GetVendorInvoiceReceiptRequest$outboundSchema.parse(
+      getVendorInvoiceReceiptRequest,
+    ),
+  );
+}
+
+export function getVendorInvoiceReceiptRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetVendorInvoiceReceiptRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetVendorInvoiceReceiptRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetVendorInvoiceReceiptRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetVendorInvoiceReceiptResponseBody$inboundSchema: z.ZodType<
+  GetVendorInvoiceReceiptResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  base64_pdf: z.string(),
+  filename: z.string().optional(),
+  content_type: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "base64_pdf": "base64Pdf",
+    "content_type": "contentType",
+  });
+});
+
+/** @internal */
+export type GetVendorInvoiceReceiptResponseBody$Outbound = {
+  base64_pdf: string;
+  filename?: string | undefined;
+  content_type?: string | undefined;
+};
+
+/** @internal */
+export const GetVendorInvoiceReceiptResponseBody$outboundSchema: z.ZodType<
+  GetVendorInvoiceReceiptResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetVendorInvoiceReceiptResponseBody
+> = z.object({
+  base64Pdf: z.string(),
+  filename: z.string().optional(),
+  contentType: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    base64Pdf: "base64_pdf",
+    contentType: "content_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetVendorInvoiceReceiptResponseBody$ {
+  /** @deprecated use `GetVendorInvoiceReceiptResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    GetVendorInvoiceReceiptResponseBody$inboundSchema;
+  /** @deprecated use `GetVendorInvoiceReceiptResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetVendorInvoiceReceiptResponseBody$outboundSchema;
+  /** @deprecated use `GetVendorInvoiceReceiptResponseBody$Outbound` instead. */
+  export type Outbound = GetVendorInvoiceReceiptResponseBody$Outbound;
+}
+
+export function getVendorInvoiceReceiptResponseBodyToJSON(
+  getVendorInvoiceReceiptResponseBody: GetVendorInvoiceReceiptResponseBody,
+): string {
+  return JSON.stringify(
+    GetVendorInvoiceReceiptResponseBody$outboundSchema.parse(
+      getVendorInvoiceReceiptResponseBody,
+    ),
+  );
+}
+
+export function getVendorInvoiceReceiptResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetVendorInvoiceReceiptResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetVendorInvoiceReceiptResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetVendorInvoiceReceiptResponseBody' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -28,6 +28,7 @@ export * from "./getuserbyid.js";
 export * from "./getvendorcredentialdetails.js";
 export * from "./getvendorcredentialfile.js";
 export * from "./getvendorinvoicedetails.js";
+export * from "./getvendorinvoicereceipt.js";
 export * from "./getvendorlegalname.js";
 export * from "./getvendorsdetails.js";
 export * from "./getwebhookendpoint.js";

package/src/react-query/index.ts

@@ -46,6 +46,7 @@ export * from "./vendorsGetSubscription.js";
 export * from "./vendorsGetVendorCredentialDetails.js";
 export * from "./vendorsGetVendorCredentialFile.js";
 export * from "./vendorsGetVendorInvoiceDetails.js";
+export * from "./vendorsGetVendorInvoiceReceipt.js";
 export * from "./vendorsGetVendorLegalName.js";
 export * from "./vendorsGetVendorsDetails.js";
 export * from "./vendorsListVendorAdditionalFacilityFields.js";

package/src/react-query/vendorsGetVendorInvoiceReceipt.ts

@@ -0,0 +1,166 @@
+/*
+ * 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 { vendorsGetVendorInvoiceReceipt } from "../funcs/vendorsGetVendorInvoiceReceipt.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 VendorsGetVendorInvoiceReceiptQueryData =
+  operations.GetVendorInvoiceReceiptResponseBody;
+
+/**
+ * Get invoice receipt for vendor
+ *
+ * @remarks
+ * Get invoice receipt for vendor
+ */
+export function useVendorsGetVendorInvoiceReceipt(
+  request: operations.GetVendorInvoiceReceiptRequest,
+  options?: QueryHookOptions<VendorsGetVendorInvoiceReceiptQueryData>,
+): UseQueryResult<VendorsGetVendorInvoiceReceiptQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsGetVendorInvoiceReceiptQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get invoice receipt for vendor
+ *
+ * @remarks
+ * Get invoice receipt for vendor
+ */
+export function useVendorsGetVendorInvoiceReceiptSuspense(
+  request: operations.GetVendorInvoiceReceiptRequest,
+  options?: SuspenseQueryHookOptions<VendorsGetVendorInvoiceReceiptQueryData>,
+): UseSuspenseQueryResult<VendorsGetVendorInvoiceReceiptQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsGetVendorInvoiceReceiptQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchVendorsGetVendorInvoiceReceipt(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorInvoiceReceiptRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetVendorInvoiceReceiptQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsGetVendorInvoiceReceiptData(
+  client: QueryClient,
+  queryKeyBase: [id: number],
+  data: VendorsGetVendorInvoiceReceiptQueryData,
+): VendorsGetVendorInvoiceReceiptQueryData | undefined {
+  const key = queryKeyVendorsGetVendorInvoiceReceipt(...queryKeyBase);
+
+  return client.setQueryData<VendorsGetVendorInvoiceReceiptQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorsGetVendorInvoiceReceipt(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorInvoiceReceipt",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsGetVendorInvoiceReceipt(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorInvoiceReceipt",
+    ],
+  });
+}
+
+export function buildVendorsGetVendorInvoiceReceiptQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorInvoiceReceiptRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetVendorInvoiceReceiptQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorInvoiceReceipt(request.id),
+    queryFn: async function vendorsGetVendorInvoiceReceiptQueryFn(
+      ctx,
+    ): Promise<VendorsGetVendorInvoiceReceiptQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsGetVendorInvoiceReceipt(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsGetVendorInvoiceReceipt(id: number): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorInvoiceReceipt",
+    id,
+  ];
+}

package/src/sdk/vendors.ts

@@ -20,6 +20,7 @@ import { vendorsGetSubscription } from "../funcs/vendorsGetSubscription.js";
 import { vendorsGetVendorCredentialDetails } from "../funcs/vendorsGetVendorCredentialDetails.js";
 import { vendorsGetVendorCredentialFile } from "../funcs/vendorsGetVendorCredentialFile.js";
 import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoiceDetails.js";
+import { vendorsGetVendorInvoiceReceipt } from "../funcs/vendorsGetVendorInvoiceReceipt.js";
 import { vendorsGetVendorLegalName } from "../funcs/vendorsGetVendorLegalName.js";
 import { vendorsGetVendorsDetails } from "../funcs/vendorsGetVendorsDetails.js";
 import { vendorsListVendorAdditionalFacilityFields } from "../funcs/vendorsListVendorAdditionalFacilityFields.js";
@@ -530,6 +531,23 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * Get invoice receipt for vendor
+   *
+   * @remarks
+   * Get invoice receipt for vendor
+   */
+  async getVendorInvoiceReceipt(
+    request: operations.GetVendorInvoiceReceiptRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetVendorInvoiceReceiptResponseBody> {
+    return unwrapAsync(vendorsGetVendorInvoiceReceipt(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get vendor invoice details
    *