@greensecurity/javascript-sdk 0.30.17 → 0.30.21

package/src/models/operations/purchasescrubcredits.ts

@@ -0,0 +1,237 @@
+/*
+ * 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 PurchaseScrubCreditsRequestBody = {
+  payLater: boolean;
+  variantId: number;
+};
+
+export type PurchaseScrubCreditsRequest = {
+  /**
+   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   */
+  vendorIdOrMe: string;
+  requestBody: PurchaseScrubCreditsRequestBody;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type PurchaseScrubCreditsResponseBody = {
+  invoiceId?: number | undefined;
+  creditBalance?: number | undefined;
+};
+
+/** @internal */
+export const PurchaseScrubCreditsRequestBody$inboundSchema: z.ZodType<
+  PurchaseScrubCreditsRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pay_later: z.boolean(),
+  variant_id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "pay_later": "payLater",
+    "variant_id": "variantId",
+  });
+});
+
+/** @internal */
+export type PurchaseScrubCreditsRequestBody$Outbound = {
+  pay_later: boolean;
+  variant_id: number;
+};
+
+/** @internal */
+export const PurchaseScrubCreditsRequestBody$outboundSchema: z.ZodType<
+  PurchaseScrubCreditsRequestBody$Outbound,
+  z.ZodTypeDef,
+  PurchaseScrubCreditsRequestBody
+> = z.object({
+  payLater: z.boolean(),
+  variantId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    payLater: "pay_later",
+    variantId: "variant_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PurchaseScrubCreditsRequestBody$ {
+  /** @deprecated use `PurchaseScrubCreditsRequestBody$inboundSchema` instead. */
+  export const inboundSchema = PurchaseScrubCreditsRequestBody$inboundSchema;
+  /** @deprecated use `PurchaseScrubCreditsRequestBody$outboundSchema` instead. */
+  export const outboundSchema = PurchaseScrubCreditsRequestBody$outboundSchema;
+  /** @deprecated use `PurchaseScrubCreditsRequestBody$Outbound` instead. */
+  export type Outbound = PurchaseScrubCreditsRequestBody$Outbound;
+}
+
+export function purchaseScrubCreditsRequestBodyToJSON(
+  purchaseScrubCreditsRequestBody: PurchaseScrubCreditsRequestBody,
+): string {
+  return JSON.stringify(
+    PurchaseScrubCreditsRequestBody$outboundSchema.parse(
+      purchaseScrubCreditsRequestBody,
+    ),
+  );
+}
+
+export function purchaseScrubCreditsRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseScrubCreditsRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseScrubCreditsRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseScrubCreditsRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PurchaseScrubCreditsRequest$inboundSchema: z.ZodType<
+  PurchaseScrubCreditsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  vendor_id_or_me: z.string(),
+  RequestBody: z.lazy(() => PurchaseScrubCreditsRequestBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "vendor_id_or_me": "vendorIdOrMe",
+    "RequestBody": "requestBody",
+  });
+});
+
+/** @internal */
+export type PurchaseScrubCreditsRequest$Outbound = {
+  vendor_id_or_me: string;
+  RequestBody: PurchaseScrubCreditsRequestBody$Outbound;
+};
+
+/** @internal */
+export const PurchaseScrubCreditsRequest$outboundSchema: z.ZodType<
+  PurchaseScrubCreditsRequest$Outbound,
+  z.ZodTypeDef,
+  PurchaseScrubCreditsRequest
+> = z.object({
+  vendorIdOrMe: z.string(),
+  requestBody: z.lazy(() => PurchaseScrubCreditsRequestBody$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 PurchaseScrubCreditsRequest$ {
+  /** @deprecated use `PurchaseScrubCreditsRequest$inboundSchema` instead. */
+  export const inboundSchema = PurchaseScrubCreditsRequest$inboundSchema;
+  /** @deprecated use `PurchaseScrubCreditsRequest$outboundSchema` instead. */
+  export const outboundSchema = PurchaseScrubCreditsRequest$outboundSchema;
+  /** @deprecated use `PurchaseScrubCreditsRequest$Outbound` instead. */
+  export type Outbound = PurchaseScrubCreditsRequest$Outbound;
+}
+
+export function purchaseScrubCreditsRequestToJSON(
+  purchaseScrubCreditsRequest: PurchaseScrubCreditsRequest,
+): string {
+  return JSON.stringify(
+    PurchaseScrubCreditsRequest$outboundSchema.parse(
+      purchaseScrubCreditsRequest,
+    ),
+  );
+}
+
+export function purchaseScrubCreditsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseScrubCreditsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseScrubCreditsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseScrubCreditsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const PurchaseScrubCreditsResponseBody$inboundSchema: z.ZodType<
+  PurchaseScrubCreditsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  invoice_id: z.number().int().optional(),
+  credit_balance: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "invoice_id": "invoiceId",
+    "credit_balance": "creditBalance",
+  });
+});
+
+/** @internal */
+export type PurchaseScrubCreditsResponseBody$Outbound = {
+  invoice_id?: number | undefined;
+  credit_balance?: number | undefined;
+};
+
+/** @internal */
+export const PurchaseScrubCreditsResponseBody$outboundSchema: z.ZodType<
+  PurchaseScrubCreditsResponseBody$Outbound,
+  z.ZodTypeDef,
+  PurchaseScrubCreditsResponseBody
+> = z.object({
+  invoiceId: z.number().int().optional(),
+  creditBalance: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    invoiceId: "invoice_id",
+    creditBalance: "credit_balance",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PurchaseScrubCreditsResponseBody$ {
+  /** @deprecated use `PurchaseScrubCreditsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = PurchaseScrubCreditsResponseBody$inboundSchema;
+  /** @deprecated use `PurchaseScrubCreditsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = PurchaseScrubCreditsResponseBody$outboundSchema;
+  /** @deprecated use `PurchaseScrubCreditsResponseBody$Outbound` instead. */
+  export type Outbound = PurchaseScrubCreditsResponseBody$Outbound;
+}
+
+export function purchaseScrubCreditsResponseBodyToJSON(
+  purchaseScrubCreditsResponseBody: PurchaseScrubCreditsResponseBody,
+): string {
+  return JSON.stringify(
+    PurchaseScrubCreditsResponseBody$outboundSchema.parse(
+      purchaseScrubCreditsResponseBody,
+    ),
+  );
+}
+
+export function purchaseScrubCreditsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseScrubCreditsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseScrubCreditsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseScrubCreditsResponseBody' 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 "./vendorsPurchaseScrubCredits.js";
 export * from "./vendorsUpdateVendorDetails.js";
 export * from "./vendorsUpdateVendorManagedByCompany.js";
 export * from "./vendorsUpdateVendorScrubDetails.js";

package/src/react-query/vendorsPurchaseScrubCredits.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsPurchaseScrubCredits } from "../funcs/vendorsPurchaseScrubCredits.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 VendorsPurchaseScrubCreditsMutationVariables = {
+  request: operations.PurchaseScrubCreditsRequest;
+  options?: RequestOptions;
+};
+
+export type VendorsPurchaseScrubCreditsMutationData =
+  operations.PurchaseScrubCreditsResponseBody;
+
+/**
+ * Purchase scrub credits
+ *
+ * @remarks
+ * Purchase scrub credits
+ */
+export function useVendorsPurchaseScrubCreditsMutation(
+  options?: MutationHookOptions<
+    VendorsPurchaseScrubCreditsMutationData,
+    Error,
+    VendorsPurchaseScrubCreditsMutationVariables
+  >,
+): UseMutationResult<
+  VendorsPurchaseScrubCreditsMutationData,
+  Error,
+  VendorsPurchaseScrubCreditsMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsPurchaseScrubCreditsMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsPurchaseScrubCredits(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "vendors", "purchaseScrubCredits"];
+}
+
+export function buildVendorsPurchaseScrubCreditsMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorsPurchaseScrubCreditsMutationVariables,
+  ) => Promise<VendorsPurchaseScrubCreditsMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorsPurchaseScrubCredits(),
+    mutationFn: function vendorsPurchaseScrubCreditsMutationFn({
+      request,
+      options,
+    }): Promise<VendorsPurchaseScrubCreditsMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorsPurchaseScrubCredits(
+        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 { vendorsPurchaseScrubCredits } from "../funcs/vendorsPurchaseScrubCredits.js";
 import { vendorsUpdateVendorDetails } from "../funcs/vendorsUpdateVendorDetails.js";
 import { vendorsUpdateVendorManagedByCompany } from "../funcs/vendorsUpdateVendorManagedByCompany.js";
 import { vendorsUpdateVendorScrubDetails } from "../funcs/vendorsUpdateVendorScrubDetails.js";
@@ -404,4 +405,21 @@ export class Vendors extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Purchase scrub credits
+   *
+   * @remarks
+   * Purchase scrub credits
+   */
+  async purchaseScrubCredits(
+    request: operations.PurchaseScrubCreditsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PurchaseScrubCreditsResponseBody> {
+    return unwrapAsync(vendorsPurchaseScrubCredits(
+      this,
+      request,
+      options,
+    ));
+  }
 }