@greensecurity/javascript-sdk 0.30.13 → 0.30.17

package/src/models/operations/listvendorinvoices.ts

@@ -5,10 +5,27 @@
 import * as z from "zod";
 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 components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Filter invoices by status
+ */
+export const InvoiceStatus = {
+  Cart: "cart",
+  Pending: "pending",
+  Canceled: "canceled",
+  ReadyToShip: "ready to ship",
+  Processed: "processed",
+  UnderReview: "under review",
+} as const;
+/**
+ * Filter invoices by status
+ */
+export type InvoiceStatus = ClosedEnum<typeof InvoiceStatus>;
+
 export type ListVendorInvoicesRequest = {
   /**
    * A comma-separated list of object attributes to sort on.
@@ -34,6 +51,14 @@ export type ListVendorInvoicesRequest = {
    * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
    */
   vendorIdOrMe: string;
+  /**
+   * Filter invoices by invoice number
+   */
+  invoiceNumber?: string | undefined;
+  /**
+   * Filter invoices by status
+   */
+  invoiceStatus?: InvoiceStatus | undefined;
 };
 
 /**
@@ -51,6 +76,27 @@ export type ListVendorInvoicesResponse = {
   result: ListVendorInvoicesResponseBody;
 };
 
+/** @internal */
+export const InvoiceStatus$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceStatus
+> = z.nativeEnum(InvoiceStatus);
+
+/** @internal */
+export const InvoiceStatus$outboundSchema: z.ZodNativeEnum<
+  typeof InvoiceStatus
+> = InvoiceStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InvoiceStatus$ {
+  /** @deprecated use `InvoiceStatus$inboundSchema` instead. */
+  export const inboundSchema = InvoiceStatus$inboundSchema;
+  /** @deprecated use `InvoiceStatus$outboundSchema` instead. */
+  export const outboundSchema = InvoiceStatus$outboundSchema;
+}
+
 /** @internal */
 export const ListVendorInvoicesRequest$inboundSchema: z.ZodType<
   ListVendorInvoicesRequest,
@@ -63,10 +109,14 @@ export const ListVendorInvoicesRequest$inboundSchema: z.ZodType<
   items_per_page: z.number().int().optional(),
   expand: z.array(components.Expand$inboundSchema).optional(),
   vendor_id_or_me: z.string(),
+  invoice_number: z.string().optional(),
+  invoice_status: InvoiceStatus$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "items_per_page": "itemsPerPage",
     "vendor_id_or_me": "vendorIdOrMe",
+    "invoice_number": "invoiceNumber",
+    "invoice_status": "invoiceStatus",
   });
 });
 
@@ -78,6 +128,8 @@ export type ListVendorInvoicesRequest$Outbound = {
   items_per_page?: number | undefined;
   expand?: Array<string> | undefined;
   vendor_id_or_me: string;
+  invoice_number?: string | undefined;
+  invoice_status?: string | undefined;
 };
 
 /** @internal */
@@ -92,10 +144,14 @@ export const ListVendorInvoicesRequest$outboundSchema: z.ZodType<
   itemsPerPage: z.number().int().optional(),
   expand: z.array(components.Expand$outboundSchema).optional(),
   vendorIdOrMe: z.string(),
+  invoiceNumber: z.string().optional(),
+  invoiceStatus: InvoiceStatus$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",
     vendorIdOrMe: "vendor_id_or_me",
+    invoiceNumber: "invoice_number",
+    invoiceStatus: "invoice_status",
   });
 });
 

package/src/models/operations/updatevendordetails.ts

@@ -0,0 +1,224 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The vendor's email_recepient value to update
+ */
+export const EmailRecepient = {
+  NoEmail: "No email",
+  Vendor: "Vendor",
+  CompanyManager: "Company manager",
+  VendorAndCompanyManager: "Vendor and company manager",
+} as const;
+/**
+ * The vendor's email_recepient value to update
+ */
+export type EmailRecepient = ClosedEnum<typeof EmailRecepient>;
+
+export type UpdateVendorDetailsRequestBody = {
+  /**
+   * The QR code value
+   */
+  qrCode?: string | undefined;
+  /**
+   * The vendor's email_recepient value to update
+   */
+  emailRecepient?: EmailRecepient | undefined;
+  /**
+   * The vendor's send_weekly_summary_email value to update
+   */
+  sendWeeklySummaryEmail?: boolean | undefined;
+  /**
+   * The vendor's title value to update
+   */
+  title?: string | undefined;
+  /**
+   * Reduced list of attributes of the User Location
+   */
+  location?: components.UserLocation | null | undefined;
+};
+
+export type UpdateVendorDetailsRequest = {
+  /**
+   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   */
+  vendorIdOrMe: string;
+  requestBody: UpdateVendorDetailsRequestBody;
+};
+
+/** @internal */
+export const EmailRecepient$inboundSchema: z.ZodNativeEnum<
+  typeof EmailRecepient
+> = z.nativeEnum(EmailRecepient);
+
+/** @internal */
+export const EmailRecepient$outboundSchema: z.ZodNativeEnum<
+  typeof EmailRecepient
+> = EmailRecepient$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EmailRecepient$ {
+  /** @deprecated use `EmailRecepient$inboundSchema` instead. */
+  export const inboundSchema = EmailRecepient$inboundSchema;
+  /** @deprecated use `EmailRecepient$outboundSchema` instead. */
+  export const outboundSchema = EmailRecepient$outboundSchema;
+}
+
+/** @internal */
+export const UpdateVendorDetailsRequestBody$inboundSchema: z.ZodType<
+  UpdateVendorDetailsRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  qr_code: z.string().optional(),
+  email_recepient: EmailRecepient$inboundSchema.optional(),
+  send_weekly_summary_email: z.boolean().optional(),
+  title: z.string().optional(),
+  location: z.nullable(components.UserLocation$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "qr_code": "qrCode",
+    "email_recepient": "emailRecepient",
+    "send_weekly_summary_email": "sendWeeklySummaryEmail",
+  });
+});
+
+/** @internal */
+export type UpdateVendorDetailsRequestBody$Outbound = {
+  qr_code?: string | undefined;
+  email_recepient?: string | undefined;
+  send_weekly_summary_email?: boolean | undefined;
+  title?: string | undefined;
+  location?: components.UserLocation$Outbound | null | undefined;
+};
+
+/** @internal */
+export const UpdateVendorDetailsRequestBody$outboundSchema: z.ZodType<
+  UpdateVendorDetailsRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateVendorDetailsRequestBody
+> = z.object({
+  qrCode: z.string().optional(),
+  emailRecepient: EmailRecepient$outboundSchema.optional(),
+  sendWeeklySummaryEmail: z.boolean().optional(),
+  title: z.string().optional(),
+  location: z.nullable(components.UserLocation$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    qrCode: "qr_code",
+    emailRecepient: "email_recepient",
+    sendWeeklySummaryEmail: "send_weekly_summary_email",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateVendorDetailsRequestBody$ {
+  /** @deprecated use `UpdateVendorDetailsRequestBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateVendorDetailsRequestBody$inboundSchema;
+  /** @deprecated use `UpdateVendorDetailsRequestBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateVendorDetailsRequestBody$outboundSchema;
+  /** @deprecated use `UpdateVendorDetailsRequestBody$Outbound` instead. */
+  export type Outbound = UpdateVendorDetailsRequestBody$Outbound;
+}
+
+export function updateVendorDetailsRequestBodyToJSON(
+  updateVendorDetailsRequestBody: UpdateVendorDetailsRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateVendorDetailsRequestBody$outboundSchema.parse(
+      updateVendorDetailsRequestBody,
+    ),
+  );
+}
+
+export function updateVendorDetailsRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateVendorDetailsRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateVendorDetailsRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateVendorDetailsRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateVendorDetailsRequest$inboundSchema: z.ZodType<
+  UpdateVendorDetailsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  vendor_id_or_me: z.string(),
+  RequestBody: z.lazy(() => UpdateVendorDetailsRequestBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "vendor_id_or_me": "vendorIdOrMe",
+    "RequestBody": "requestBody",
+  });
+});
+
+/** @internal */
+export type UpdateVendorDetailsRequest$Outbound = {
+  vendor_id_or_me: string;
+  RequestBody: UpdateVendorDetailsRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateVendorDetailsRequest$outboundSchema: z.ZodType<
+  UpdateVendorDetailsRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateVendorDetailsRequest
+> = z.object({
+  vendorIdOrMe: z.string(),
+  requestBody: z.lazy(() => UpdateVendorDetailsRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    vendorIdOrMe: "vendor_id_or_me",
+    requestBody: "RequestBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateVendorDetailsRequest$ {
+  /** @deprecated use `UpdateVendorDetailsRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateVendorDetailsRequest$inboundSchema;
+  /** @deprecated use `UpdateVendorDetailsRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateVendorDetailsRequest$outboundSchema;
+  /** @deprecated use `UpdateVendorDetailsRequest$Outbound` instead. */
+  export type Outbound = UpdateVendorDetailsRequest$Outbound;
+}
+
+export function updateVendorDetailsRequestToJSON(
+  updateVendorDetailsRequest: UpdateVendorDetailsRequest,
+): string {
+  return JSON.stringify(
+    UpdateVendorDetailsRequest$outboundSchema.parse(updateVendorDetailsRequest),
+  );
+}
+
+export function updateVendorDetailsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateVendorDetailsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateVendorDetailsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateVendorDetailsRequest' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -33,6 +33,7 @@ export * from "./vendorsListVendorManagedByCompanies.js";
 export * from "./vendorsListVendorScrubDetails.js";
 export * from "./vendorsListVendorScrubPackages.js";
 export * from "./vendorsListVendorScrubPurchases.js";
+export * from "./vendorsUpdateVendorDetails.js";
 export * from "./vendorsUpdateVendorManagedByCompany.js";
 export * from "./vendorsUpdateVendorScrubDetails.js";
 export * from "./webhooksGetWebhookEndpoint.js";

package/src/react-query/vendorsListVendorInvoices.ts

@@ -208,6 +208,8 @@ export function setVendorsListVendorInvoicesData(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       expand?: Array<components.Expand> | undefined;
+      invoiceNumber?: string | undefined;
+      invoiceStatus?: operations.InvoiceStatus | undefined;
     },
   ],
   data: VendorsListVendorInvoicesQueryData,
@@ -228,6 +230,8 @@ export function invalidateVendorsListVendorInvoices(
         page?: number | undefined;
         itemsPerPage?: number | undefined;
         expand?: Array<components.Expand> | undefined;
+        invoiceNumber?: string | undefined;
+        invoiceStatus?: operations.InvoiceStatus | undefined;
       },
     ]
   >,
@@ -275,6 +279,8 @@ export function buildVendorsListVendorInvoicesQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       expand: request.expand,
+      invoiceNumber: request.invoiceNumber,
+      invoiceStatus: request.invoiceStatus,
     }),
     queryFn: async function vendorsListVendorInvoicesQueryFn(
       ctx,
@@ -314,6 +320,8 @@ export function buildVendorsListVendorInvoicesInfiniteQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       expand: request.expand,
+      invoiceNumber: request.invoiceNumber,
+      invoiceStatus: request.invoiceStatus,
     }),
     queryFn: async function vendorsListVendorInvoicesQuery(
       ctx,
@@ -352,6 +360,8 @@ export function queryKeyVendorsListVendorInvoices(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     expand?: Array<components.Expand> | undefined;
+    invoiceNumber?: string | undefined;
+    invoiceStatus?: operations.InvoiceStatus | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/vendorsUpdateVendorDetails.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsUpdateVendorDetails } from "../funcs/vendorsUpdateVendorDetails.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 { MutationHookOptions } from "./_types.js";
+
+export type VendorsUpdateVendorDetailsMutationVariables = {
+  request: operations.UpdateVendorDetailsRequest;
+  options?: RequestOptions;
+};
+
+export type VendorsUpdateVendorDetailsMutationData = boolean;
+
+/**
+ * Update vendor details
+ *
+ * @remarks
+ * It will update the vendor details
+ */
+export function useVendorsUpdateVendorDetailsMutation(
+  options?: MutationHookOptions<
+    VendorsUpdateVendorDetailsMutationData,
+    Error,
+    VendorsUpdateVendorDetailsMutationVariables
+  >,
+): UseMutationResult<
+  VendorsUpdateVendorDetailsMutationData,
+  Error,
+  VendorsUpdateVendorDetailsMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsUpdateVendorDetailsMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsUpdateVendorDetails(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "vendors", "updateVendorDetails"];
+}
+
+export function buildVendorsUpdateVendorDetailsMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorsUpdateVendorDetailsMutationVariables,
+  ) => Promise<VendorsUpdateVendorDetailsMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorsUpdateVendorDetails(),
+    mutationFn: function vendorsUpdateVendorDetailsMutationFn({
+      request,
+      options,
+    }): Promise<VendorsUpdateVendorDetailsMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorsUpdateVendorDetails(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/sdk/vendors.ts

@@ -18,6 +18,7 @@ import { vendorsListVendorManagedByCompanies } from "../funcs/vendorsListVendorM
 import { vendorsListVendorScrubDetails } from "../funcs/vendorsListVendorScrubDetails.js";
 import { vendorsListVendorScrubPackages } from "../funcs/vendorsListVendorScrubPackages.js";
 import { vendorsListVendorScrubPurchases } from "../funcs/vendorsListVendorScrubPurchases.js";
+import { vendorsUpdateVendorDetails } from "../funcs/vendorsUpdateVendorDetails.js";
 import { vendorsUpdateVendorManagedByCompany } from "../funcs/vendorsUpdateVendorManagedByCompany.js";
 import { vendorsUpdateVendorScrubDetails } from "../funcs/vendorsUpdateVendorScrubDetails.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -273,6 +274,23 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * Update vendor details
+   *
+   * @remarks
+   * It will update the vendor details
+   */
+  async updateVendorDetails(
+    request: operations.UpdateVendorDetailsRequest,
+    options?: RequestOptions,
+  ): Promise<boolean> {
+    return unwrapAsync(vendorsUpdateVendorDetails(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List vendor credits
    *