ce-storefront 0.18.0 → 0.18.2

package/src/funcs/customersListSavedPaymentMethods.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CeStorefrontCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { CeStorefrontError } from "../models/errors/cestorefronterror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List all saved payment methods
+ *
+ * @remarks
+ * This endpoint acts as a proxy for JusPay’s “Fetch Saved Payment Methods” API. It enables to securely retrieve a list of payment methods (such as saved cards, UPI handles, wallets) that have been previously stored for a given customer.
+ *
+ * The operation helps streamline the checkout flow by allowing users to quickly select from existing payment methods, reducing input friction and improving conversion.
+ *
+ * API documentation of JusPay can be found at below link:
+ *
+ * https://juspay.io/in/docs/api-reference/docs/express-checkout/fetch-saved-payment-methods
+ *
+ * @see {@link https://llm-docs.commercengine.io/storefront/operations/list-saved-payment-methods} - API reference for the list-saved-payment-methods operation
+ */
+export function customersListSavedPaymentMethods(
+  client: CeStorefrontCore,
+  request: operations.ListSavedPaymentMethodsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListSavedPaymentMethodsResponseBody,
+    | errors.Unauthorized
+    | errors.NotFound
+    | CeStorefrontError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CeStorefrontCore,
+  request: operations.ListSavedPaymentMethodsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListSavedPaymentMethodsResponseBody,
+      | errors.Unauthorized
+      | errors.NotFound
+      | CeStorefrontError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListSavedPaymentMethodsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    customer_id: encodeSimple("customer_id", payload.customer_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/customers/{customer_id}/payment-methods")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.authorization);
+  const securityInput = secConfig == null ? {} : { authorization: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "list-saved-payment-methods",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.authorization,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "404", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.ListSavedPaymentMethodsResponseBody,
+    | errors.Unauthorized
+    | errors.NotFound
+    | CeStorefrontError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListSavedPaymentMethodsResponseBody$inboundSchema),
+    M.jsonErr(401, errors.Unauthorized$inboundSchema),
+    M.jsonErr(404, errors.NotFound$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -80,7 +80,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.18.0",
-  genVersion: "2.730.5",
-  userAgent: "speakeasy-sdk/typescript 0.18.0 2.730.5 1.0 ce-storefront",
+  sdkVersion: "0.18.2",
+  genVersion: "2.731.6",
+  userAgent: "speakeasy-sdk/typescript 0.18.2 2.731.6 1.0 ce-storefront",
 } as const;

package/src/models/components/index.ts

@@ -37,8 +37,15 @@ export * from "./fulfillmentpreferenceinput.js";
 export * from "./generateotpwithemail.js";
 export * from "./generateotpwithphone.js";
 export * from "./item.js";
+export * from "./juspaycard.js";
+export * from "./juspayexpresscheckout.js";
+export * from "./juspayhypercheckout.js";
+export * from "./juspaynetbanking.js";
 export * from "./juspaypaymentgatewayparams.js";
 export * from "./juspaypaymentinfo.js";
+export * from "./juspaysavedcardtoken.js";
+export * from "./juspayupicollect.js";
+export * from "./juspayupiintent.js";
 export * from "./lotbatchdetail.js";
 export * from "./multiselectattribute.js";
 export * from "./netbankingpayment.js";
@@ -54,8 +61,8 @@ export * from "./ordershipment.js";
 export * from "./pagination.js";
 export * from "./partialcollectanddelivery.js";
 export * from "./partialcollectanddeliveryinput.js";
-export * from "./paymentgateway.js";
 export * from "./paymentgatewayparams.js";
+export * from "./paymentmethodpayload.js";
 export * from "./payupaymentgatewayparams.js";
 export * from "./payupaymentinfo.js";
 export * from "./pincode.js";
@@ -72,6 +79,7 @@ export * from "./productreview.js";
 export * from "./productshipping.js";
 export * from "./productsubscription.js";
 export * from "./productvideo.js";
+export * from "./savedpaymentmethod.js";
 export * from "./searchproduct.js";
 export * from "./security.js";
 export * from "./seo.js";

package/src/models/components/juspaycard.ts

@@ -0,0 +1,185 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const PaymentMethod = {
+  Visa: "VISA",
+  Master: "MASTER",
+} as const;
+export type PaymentMethod = ClosedEnum<typeof PaymentMethod>;
+
+/**
+ * @see {@link https://llm-docs.commercengine.io/storefront/schemas/JusPayCard} - API reference for the JusPayCard schema
+ */
+export type JusPayCard = {
+  paymentMethodSlug: string;
+  integrationType?: "express-checkout" | undefined;
+  gatewayReferenceId: string;
+  returnUrl?: string | undefined;
+  redirectAfterPayment: boolean;
+  authType?: "OTP" | undefined;
+  tokenize: boolean;
+  saveToLocker: boolean;
+  paymentMethodType?: "CARD" | undefined;
+  paymentMethod: PaymentMethod;
+  cardNumber: string;
+  cardExpMonth: string;
+  cardExpYear: string;
+  nameOnCard: string;
+  cardSecurityCode: string;
+};
+
+/** @internal */
+export const PaymentMethod$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentMethod
+> = z.nativeEnum(PaymentMethod);
+
+/** @internal */
+export const PaymentMethod$outboundSchema: z.ZodNativeEnum<
+  typeof PaymentMethod
+> = PaymentMethod$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentMethod$ {
+  /** @deprecated use `PaymentMethod$inboundSchema` instead. */
+  export const inboundSchema = PaymentMethod$inboundSchema;
+  /** @deprecated use `PaymentMethod$outboundSchema` instead. */
+  export const outboundSchema = PaymentMethod$outboundSchema;
+}
+
+/** @internal */
+export const JusPayCard$inboundSchema: z.ZodType<
+  JusPayCard,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  payment_method_slug: z.string(),
+  integration_type: z.literal("express-checkout").default("express-checkout")
+    .optional(),
+  gateway_reference_id: z.string(),
+  return_url: z.string().optional(),
+  redirect_after_payment: z.boolean(),
+  auth_type: z.literal("OTP").default("OTP").optional(),
+  tokenize: z.boolean(),
+  save_to_locker: z.boolean(),
+  payment_method_type: z.literal("CARD").default("CARD").optional(),
+  payment_method: PaymentMethod$inboundSchema,
+  card_number: z.string(),
+  card_exp_month: z.string(),
+  card_exp_year: z.string(),
+  name_on_card: z.string(),
+  card_security_code: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "payment_method_slug": "paymentMethodSlug",
+    "integration_type": "integrationType",
+    "gateway_reference_id": "gatewayReferenceId",
+    "return_url": "returnUrl",
+    "redirect_after_payment": "redirectAfterPayment",
+    "auth_type": "authType",
+    "save_to_locker": "saveToLocker",
+    "payment_method_type": "paymentMethodType",
+    "payment_method": "paymentMethod",
+    "card_number": "cardNumber",
+    "card_exp_month": "cardExpMonth",
+    "card_exp_year": "cardExpYear",
+    "name_on_card": "nameOnCard",
+    "card_security_code": "cardSecurityCode",
+  });
+});
+
+/** @internal */
+export type JusPayCard$Outbound = {
+  payment_method_slug: string;
+  integration_type: "express-checkout";
+  gateway_reference_id: string;
+  return_url?: string | undefined;
+  redirect_after_payment: boolean;
+  auth_type: "OTP";
+  tokenize: boolean;
+  save_to_locker: boolean;
+  payment_method_type: "CARD";
+  payment_method: string;
+  card_number: string;
+  card_exp_month: string;
+  card_exp_year: string;
+  name_on_card: string;
+  card_security_code: string;
+};
+
+/** @internal */
+export const JusPayCard$outboundSchema: z.ZodType<
+  JusPayCard$Outbound,
+  z.ZodTypeDef,
+  JusPayCard
+> = z.object({
+  paymentMethodSlug: z.string(),
+  integrationType: z.literal("express-checkout"),
+  gatewayReferenceId: z.string(),
+  returnUrl: z.string().optional(),
+  redirectAfterPayment: z.boolean(),
+  authType: z.literal("OTP"),
+  tokenize: z.boolean(),
+  saveToLocker: z.boolean(),
+  paymentMethodType: z.literal("CARD"),
+  paymentMethod: PaymentMethod$outboundSchema,
+  cardNumber: z.string(),
+  cardExpMonth: z.string(),
+  cardExpYear: z.string(),
+  nameOnCard: z.string(),
+  cardSecurityCode: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    paymentMethodSlug: "payment_method_slug",
+    integrationType: "integration_type",
+    gatewayReferenceId: "gateway_reference_id",
+    returnUrl: "return_url",
+    redirectAfterPayment: "redirect_after_payment",
+    authType: "auth_type",
+    saveToLocker: "save_to_locker",
+    paymentMethodType: "payment_method_type",
+    paymentMethod: "payment_method",
+    cardNumber: "card_number",
+    cardExpMonth: "card_exp_month",
+    cardExpYear: "card_exp_year",
+    nameOnCard: "name_on_card",
+    cardSecurityCode: "card_security_code",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace JusPayCard$ {
+  /** @deprecated use `JusPayCard$inboundSchema` instead. */
+  export const inboundSchema = JusPayCard$inboundSchema;
+  /** @deprecated use `JusPayCard$outboundSchema` instead. */
+  export const outboundSchema = JusPayCard$outboundSchema;
+  /** @deprecated use `JusPayCard$Outbound` instead. */
+  export type Outbound = JusPayCard$Outbound;
+}
+
+export function jusPayCardToJSON(jusPayCard: JusPayCard): string {
+  return JSON.stringify(JusPayCard$outboundSchema.parse(jusPayCard));
+}
+
+export function jusPayCardFromJSON(
+  jsonString: string,
+): SafeParseResult<JusPayCard, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => JusPayCard$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'JusPayCard' from JSON`,
+  );
+}

package/src/models/components/juspayexpresscheckout.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  JusPayCard,
+  JusPayCard$inboundSchema,
+  JusPayCard$Outbound,
+  JusPayCard$outboundSchema,
+} from "./juspaycard.js";
+import {
+  JuspayNetBanking,
+  JuspayNetBanking$inboundSchema,
+  JuspayNetBanking$Outbound,
+  JuspayNetBanking$outboundSchema,
+} from "./juspaynetbanking.js";
+import {
+  JusPaySavedCardToken,
+  JusPaySavedCardToken$inboundSchema,
+  JusPaySavedCardToken$Outbound,
+  JusPaySavedCardToken$outboundSchema,
+} from "./juspaysavedcardtoken.js";
+import {
+  JuspayUpiCollect,
+  JuspayUpiCollect$inboundSchema,
+  JuspayUpiCollect$Outbound,
+  JuspayUpiCollect$outboundSchema,
+} from "./juspayupicollect.js";
+import {
+  JuspayUpiIntent,
+  JuspayUpiIntent$inboundSchema,
+  JuspayUpiIntent$Outbound,
+  JuspayUpiIntent$outboundSchema,
+} from "./juspayupiintent.js";
+
+/**
+ * @see {@link https://llm-docs.commercengine.io/storefront/schemas/JusPayExpressCheckout} - API reference for the JusPayExpressCheckout schema
+ */
+export type JusPayExpressCheckout =
+  | JusPayCard
+  | JusPaySavedCardToken
+  | JuspayUpiIntent
+  | JuspayUpiCollect
+  | JuspayNetBanking;
+
+/** @internal */
+export const JusPayExpressCheckout$inboundSchema: z.ZodType<
+  JusPayExpressCheckout,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  JusPayCard$inboundSchema,
+  JusPaySavedCardToken$inboundSchema,
+  JuspayUpiIntent$inboundSchema,
+  JuspayUpiCollect$inboundSchema,
+  JuspayNetBanking$inboundSchema,
+]);
+
+/** @internal */
+export type JusPayExpressCheckout$Outbound =
+  | JusPayCard$Outbound
+  | JusPaySavedCardToken$Outbound
+  | JuspayUpiIntent$Outbound
+  | JuspayUpiCollect$Outbound
+  | JuspayNetBanking$Outbound;
+
+/** @internal */
+export const JusPayExpressCheckout$outboundSchema: z.ZodType<
+  JusPayExpressCheckout$Outbound,
+  z.ZodTypeDef,
+  JusPayExpressCheckout
+> = z.union([
+  JusPayCard$outboundSchema,
+  JusPaySavedCardToken$outboundSchema,
+  JuspayUpiIntent$outboundSchema,
+  JuspayUpiCollect$outboundSchema,
+  JuspayNetBanking$outboundSchema,
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace JusPayExpressCheckout$ {
+  /** @deprecated use `JusPayExpressCheckout$inboundSchema` instead. */
+  export const inboundSchema = JusPayExpressCheckout$inboundSchema;
+  /** @deprecated use `JusPayExpressCheckout$outboundSchema` instead. */
+  export const outboundSchema = JusPayExpressCheckout$outboundSchema;
+  /** @deprecated use `JusPayExpressCheckout$Outbound` instead. */
+  export type Outbound = JusPayExpressCheckout$Outbound;
+}
+
+export function jusPayExpressCheckoutToJSON(
+  jusPayExpressCheckout: JusPayExpressCheckout,
+): string {
+  return JSON.stringify(
+    JusPayExpressCheckout$outboundSchema.parse(jusPayExpressCheckout),
+  );
+}
+
+export function jusPayExpressCheckoutFromJSON(
+  jsonString: string,
+): SafeParseResult<JusPayExpressCheckout, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => JusPayExpressCheckout$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'JusPayExpressCheckout' from JSON`,
+  );
+}

package/src/models/components/juspayhypercheckout.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Action = {
+  PaymentPage: "paymentPage",
+} as const;
+export type Action = ClosedEnum<typeof Action>;
+
+/**
+ * @see {@link https://llm-docs.commercengine.io/storefront/schemas/JusPayHyperCheckout} - API reference for the JusPayHyperCheckout schema
+ */
+export type JusPayHyperCheckout = {
+  paymentMethodSlug: string;
+  integrationType?: "hyper-checkout" | undefined;
+  gatewayReferenceId: string;
+  returnUrl: string;
+  action: Action;
+};
+
+/** @internal */
+export const Action$inboundSchema: z.ZodNativeEnum<typeof Action> = z
+  .nativeEnum(Action);
+
+/** @internal */
+export const Action$outboundSchema: z.ZodNativeEnum<typeof Action> =
+  Action$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Action$ {
+  /** @deprecated use `Action$inboundSchema` instead. */
+  export const inboundSchema = Action$inboundSchema;
+  /** @deprecated use `Action$outboundSchema` instead. */
+  export const outboundSchema = Action$outboundSchema;
+}
+
+/** @internal */
+export const JusPayHyperCheckout$inboundSchema: z.ZodType<
+  JusPayHyperCheckout,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  payment_method_slug: z.string(),
+  integration_type: z.literal("hyper-checkout").default("hyper-checkout")
+    .optional(),
+  gateway_reference_id: z.string(),
+  return_url: z.string(),
+  action: Action$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "payment_method_slug": "paymentMethodSlug",
+    "integration_type": "integrationType",
+    "gateway_reference_id": "gatewayReferenceId",
+    "return_url": "returnUrl",
+  });
+});
+
+/** @internal */
+export type JusPayHyperCheckout$Outbound = {
+  payment_method_slug: string;
+  integration_type: "hyper-checkout";
+  gateway_reference_id: string;
+  return_url: string;
+  action: string;
+};
+
+/** @internal */
+export const JusPayHyperCheckout$outboundSchema: z.ZodType<
+  JusPayHyperCheckout$Outbound,
+  z.ZodTypeDef,
+  JusPayHyperCheckout
+> = z.object({
+  paymentMethodSlug: z.string(),
+  integrationType: z.literal("hyper-checkout"),
+  gatewayReferenceId: z.string(),
+  returnUrl: z.string(),
+  action: Action$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    paymentMethodSlug: "payment_method_slug",
+    integrationType: "integration_type",
+    gatewayReferenceId: "gateway_reference_id",
+    returnUrl: "return_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace JusPayHyperCheckout$ {
+  /** @deprecated use `JusPayHyperCheckout$inboundSchema` instead. */
+  export const inboundSchema = JusPayHyperCheckout$inboundSchema;
+  /** @deprecated use `JusPayHyperCheckout$outboundSchema` instead. */
+  export const outboundSchema = JusPayHyperCheckout$outboundSchema;
+  /** @deprecated use `JusPayHyperCheckout$Outbound` instead. */
+  export type Outbound = JusPayHyperCheckout$Outbound;
+}
+
+export function jusPayHyperCheckoutToJSON(
+  jusPayHyperCheckout: JusPayHyperCheckout,
+): string {
+  return JSON.stringify(
+    JusPayHyperCheckout$outboundSchema.parse(jusPayHyperCheckout),
+  );
+}
+
+export function jusPayHyperCheckoutFromJSON(
+  jsonString: string,
+): SafeParseResult<JusPayHyperCheckout, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => JusPayHyperCheckout$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'JusPayHyperCheckout' from JSON`,
+  );
+}