ce-storefront 0.3.1 → 0.3.3

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "ce-storefront",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ce-storefront",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "author": "TarkAI",
   "type": "module",
   "main": "./esm/index.js",

package/src/funcs/ordersRetryPayment.ts

@@ -27,7 +27,7 @@ import { Result } from "../types/fp.js";
  * Retry payment
  *
  * @remarks
- * to generate new payment request
+ * To generate new payment request if first payment request is failed or expired. Retry payment request can be made after 15 mins of last request or immediately after last payment request is marked as failed.
  */
 export async function ordersRetryPayment(
   client: CeStorefrontCore,

package/src/lib/config.ts

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

package/src/models/components/juspaypaymentgatewayparams.ts

@@ -22,7 +22,7 @@ export const IntegrationType = {
 export type IntegrationType = ClosedEnum<typeof IntegrationType>;
 
 export type JuspayPaymentGatewayParams = {
-  paymentGateway?: "PAYU" | undefined;
+  paymentGateway?: "JUSPAY" | undefined;
   action: Action;
   integrationType: IntegrationType;
   returnUrl: string;
@@ -75,7 +75,7 @@ export const JuspayPaymentGatewayParams$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  payment_gateway: z.literal("PAYU").optional(),
+  payment_gateway: z.literal("JUSPAY").optional(),
   action: Action$inboundSchema,
   integration_type: IntegrationType$inboundSchema,
   return_url: z.string(),
@@ -91,7 +91,7 @@ export const JuspayPaymentGatewayParams$inboundSchema: z.ZodType<
 
 /** @internal */
 export type JuspayPaymentGatewayParams$Outbound = {
-  payment_gateway: "PAYU";
+  payment_gateway: "JUSPAY";
   action: string;
   integration_type: string;
   return_url: string;
@@ -104,7 +104,7 @@ export const JuspayPaymentGatewayParams$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   JuspayPaymentGatewayParams
 > = z.object({
-  paymentGateway: z.literal("PAYU").default("PAYU" as const),
+  paymentGateway: z.literal("JUSPAY").default("JUSPAY" as const),
   action: Action$outboundSchema,
   integrationType: IntegrationType$outboundSchema,
   returnUrl: z.string(),

package/src/models/components/juspaypaymentinfo.ts

@@ -13,14 +13,30 @@ export type PaymentLinks = {
   web?: string | undefined;
 };
 
+/**
+ * Use for taking consent of subscription payments. If this key is used it will ask user to give consent for subscription payment.
+ *
+ * @remarks
+ */
 export const OptionsCreateMandate = {
   Required: "REQUIRED",
 } as const;
+/**
+ * Use for taking consent of subscription payments. If this key is used it will ask user to give consent for subscription payment.
+ *
+ * @remarks
+ */
 export type OptionsCreateMandate = ClosedEnum<typeof OptionsCreateMandate>;
 
+/**
+ * subscription frequency
+ */
 export const MandateFrequency = {
   Monthly: "MONTHLY",
 } as const;
+/**
+ * subscription frequency
+ */
 export type MandateFrequency = ClosedEnum<typeof MandateFrequency>;
 
 /**
@@ -69,10 +85,27 @@ export type Payload = {
   customerEmail?: string | undefined;
   currency?: string | undefined;
   description?: string | undefined;
+  /**
+   * Use for taking consent of subscription payments. If this key is used it will ask user to give consent for subscription payment.
+   *
+   * @remarks
+   */
   optionsCreateMandate?: OptionsCreateMandate | undefined;
+  /**
+   * Maximum amount that can be charged in recurring payment.
+   */
   mandateMaxAmount?: string | undefined;
+  /**
+   * subscription start time
+   */
   mandateStartDate?: string | undefined;
+  /**
+   * subscription end time
+   */
   mandateEndDate?: string | undefined;
+  /**
+   * subscription frequency
+   */
   mandateFrequency?: MandateFrequency | undefined;
   /**
    * When frequency is passed as WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, or YEARLY then is it required that the exact day of the period should be passed.

package/src/models/components/payupaymentinfo.ts

@@ -11,13 +11,19 @@ import { RFCDate } from "../../types/rfcdate.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * This parameter signifies a successful consent taken from the user by the merchant. This parameter must contain 1 for a successful consent. Without this parameter sent as 1, subscription cannot be set up.
+ * To be used in case we want to take consent for subscription payment.
+ *
+ * @remarks
+ * To create consent for subscription, value of this parameter must be 1.
  */
 export const Si = {
   One: "1",
 } as const;
 /**
- * This parameter signifies a successful consent taken from the user by the merchant. This parameter must contain 1 for a successful consent. Without this parameter sent as 1, subscription cannot be set up.
+ * To be used in case we want to take consent for subscription payment.
+ *
+ * @remarks
+ * To create consent for subscription, value of this parameter must be 1.
  */
 export type Si = ClosedEnum<typeof Si>;
 
@@ -26,17 +32,48 @@ export const BillingCurrency = {
 } as const;
 export type BillingCurrency = ClosedEnum<typeof BillingCurrency>;
 
+/**
+ * Subscription frequency.
+ */
 export const BillingCycle = {
   Monthly: "MONTHLY",
 } as const;
+/**
+ * Subscription frequency.
+ */
 export type BillingCycle = ClosedEnum<typeof BillingCycle>;
 
+/**
+ * Send this json object for creating subscription consent.
+ */
 export type SiDetails = {
+  /**
+   * Maximum amount that can be charged in recurring payment.
+   */
   billingAmount?: number | undefined;
   billingCurrency?: BillingCurrency | undefined;
+  /**
+   * Subscription frequency.
+   */
   billingCycle?: BillingCycle | undefined;
+  /**
+   * Billing Interval is closely coupled with the billingCycle field and denotes at what frequency, the subscription plan needs to be executed. For monthly subscriptions, parameter values need to be sent in the request are:
+   *
+   * @remarks
+   * billingCycle = MONTHLY
+   * billingInterval = 1
+   * Similarly, by keeping the following values, customer will be charged once in every 3 days:
+   * billingCycle = DAILY
+   * billingInterval = 3
+   */
   billingInterval?: number | undefined;
+  /**
+   * subscription start date
+   */
   paymentStartDate?: RFCDate | undefined;
+  /**
+   * subscription end date
+   */
   paymentEndDate?: RFCDate | undefined;
 };
 
@@ -51,9 +88,15 @@ export type PayuPaymentInfo = {
   email?: string | undefined;
   phone?: string | undefined;
   /**
-   * This parameter signifies a successful consent taken from the user by the merchant. This parameter must contain 1 for a successful consent. Without this parameter sent as 1, subscription cannot be set up.
+   * To be used in case we want to take consent for subscription payment.
+   *
+   * @remarks
+   * To create consent for subscription, value of this parameter must be 1.
    */
   si?: Si | undefined;
+  /**
+   * Send this json object for creating subscription consent.
+   */
   siDetails?: SiDetails | undefined;
   /**
    * return url in case of payment failure.