ce-storefront 0.20.0 → 0.21.0

package/src/models/operations/listmarketplacecrosssellproducts.ts

@@ -0,0 +1,145 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListMarketplaceCrosssellProductsRequest = {
+  /**
+   * This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned.
+   */
+  xCustomerGroupId?: string | undefined;
+  /**
+   * no of rows per page
+   */
+  limit?: number | undefined;
+  /**
+   * page number in pagination
+   */
+  page?: number | undefined;
+  /**
+   * Product ids of cart items
+   */
+  productId?: Array<string> | undefined;
+  /**
+   * json to sort records
+   */
+  sortBy?: string | undefined;
+};
+
+export type ListMarketplaceCrosssellProductsContent = {
+  products: Array<components.Item>;
+  /**
+   * pagination metadata structure
+   */
+  pagination: components.Pagination;
+};
+
+/**
+ * Success response
+ */
+export type ListMarketplaceCrosssellProductsResponseBody = {
+  message: string;
+  success: boolean;
+  content: ListMarketplaceCrosssellProductsContent;
+};
+
+/** @internal */
+export type ListMarketplaceCrosssellProductsRequest$Outbound = {
+  "x-customer-group-id"?: string | undefined;
+  limit?: number | undefined;
+  page?: number | undefined;
+  product_id?: Array<string> | undefined;
+  sort_by?: string | undefined;
+};
+
+/** @internal */
+export const ListMarketplaceCrosssellProductsRequest$outboundSchema: z.ZodType<
+  ListMarketplaceCrosssellProductsRequest$Outbound,
+  z.ZodTypeDef,
+  ListMarketplaceCrosssellProductsRequest
+> = z.object({
+  xCustomerGroupId: z.string().optional(),
+  limit: z.number().int().optional(),
+  page: z.number().int().optional(),
+  productId: z.array(z.string()).optional(),
+  sortBy: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    xCustomerGroupId: "x-customer-group-id",
+    productId: "product_id",
+    sortBy: "sort_by",
+  });
+});
+
+export function listMarketplaceCrosssellProductsRequestToJSON(
+  listMarketplaceCrosssellProductsRequest:
+    ListMarketplaceCrosssellProductsRequest,
+): string {
+  return JSON.stringify(
+    ListMarketplaceCrosssellProductsRequest$outboundSchema.parse(
+      listMarketplaceCrosssellProductsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListMarketplaceCrosssellProductsContent$inboundSchema: z.ZodType<
+  ListMarketplaceCrosssellProductsContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  products: z.array(components.Item$inboundSchema),
+  pagination: components.Pagination$inboundSchema,
+});
+
+export function listMarketplaceCrosssellProductsContentFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListMarketplaceCrosssellProductsContent,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceCrosssellProductsContent$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListMarketplaceCrosssellProductsContent' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListMarketplaceCrosssellProductsResponseBody$inboundSchema:
+  z.ZodType<
+    ListMarketplaceCrosssellProductsResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    message: z.string(),
+    success: z.boolean(),
+    content: z.lazy(() =>
+      ListMarketplaceCrosssellProductsContent$inboundSchema
+    ),
+  });
+
+export function listMarketplaceCrosssellProductsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListMarketplaceCrosssellProductsResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceCrosssellProductsResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListMarketplaceCrosssellProductsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/listmarketplaceproductreviews.ts

@@ -0,0 +1,148 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListMarketplaceProductReviewsRequest = {
+  /**
+   * page number of pagination list
+   */
+  page?: number | undefined;
+  /**
+   * no of rows per page
+   */
+  limit?: number | undefined;
+  /**
+   * JSON string format: {"field1":"asc", "field2":"desc"}
+   */
+  sortBy?: string | undefined;
+  /**
+   * search keyword
+   */
+  search?: string | undefined;
+  /**
+   * id of a particular product
+   */
+  productId: string;
+  /**
+   * filter review with review tag
+   */
+  reviewTag?: string | undefined;
+};
+
+export type ListMarketplaceProductReviewsContent = {
+  reviews: Array<components.ProductReview>;
+  reviewTags?: Array<string> | null | undefined;
+  /**
+   * pagination metadata structure
+   */
+  pagination?: components.Pagination | undefined;
+};
+
+/**
+ * Success response
+ */
+export type ListMarketplaceProductReviewsResponseBody = {
+  message: string;
+  success: boolean;
+  content: ListMarketplaceProductReviewsContent;
+};
+
+/** @internal */
+export type ListMarketplaceProductReviewsRequest$Outbound = {
+  page?: number | undefined;
+  limit?: number | undefined;
+  sort_by?: string | undefined;
+  search?: string | undefined;
+  product_id: string;
+  review_tag?: string | undefined;
+};
+
+/** @internal */
+export const ListMarketplaceProductReviewsRequest$outboundSchema: z.ZodType<
+  ListMarketplaceProductReviewsRequest$Outbound,
+  z.ZodTypeDef,
+  ListMarketplaceProductReviewsRequest
+> = z.object({
+  page: z.number().optional(),
+  limit: z.number().int().optional(),
+  sortBy: z.string().optional(),
+  search: z.string().optional(),
+  productId: z.string(),
+  reviewTag: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    sortBy: "sort_by",
+    productId: "product_id",
+    reviewTag: "review_tag",
+  });
+});
+
+export function listMarketplaceProductReviewsRequestToJSON(
+  listMarketplaceProductReviewsRequest: ListMarketplaceProductReviewsRequest,
+): string {
+  return JSON.stringify(
+    ListMarketplaceProductReviewsRequest$outboundSchema.parse(
+      listMarketplaceProductReviewsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListMarketplaceProductReviewsContent$inboundSchema: z.ZodType<
+  ListMarketplaceProductReviewsContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  reviews: z.array(components.ProductReview$inboundSchema),
+  review_tags: z.nullable(z.array(z.string())).optional(),
+  pagination: components.Pagination$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "review_tags": "reviewTags",
+  });
+});
+
+export function listMarketplaceProductReviewsContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ListMarketplaceProductReviewsContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceProductReviewsContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListMarketplaceProductReviewsContent' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListMarketplaceProductReviewsResponseBody$inboundSchema: z.ZodType<
+  ListMarketplaceProductReviewsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  success: z.boolean(),
+  content: z.lazy(() => ListMarketplaceProductReviewsContent$inboundSchema),
+});
+
+export function listMarketplaceProductReviewsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListMarketplaceProductReviewsResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceProductReviewsResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListMarketplaceProductReviewsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/listmarketplaceproducts.ts

@@ -0,0 +1,143 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListMarketplaceProductsRequest = {
+  /**
+   * page number of pagination list
+   */
+  page?: number | undefined;
+  /**
+   * no of rows per page
+   */
+  limit?: number | undefined;
+  /**
+   * JSON string format: {"field1":"asc", "field2":"desc"}
+   */
+  sortBy?: string | undefined;
+  /**
+   * This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned.
+   */
+  xCustomerGroupId?: string | undefined;
+  /**
+   * filter products by categories ids
+   */
+  categoryId?: Array<string> | undefined;
+  /**
+   * filter products by categories slugs
+   */
+  categorySlug?: Array<string> | undefined;
+  /**
+   * Determines whether to include or exlude inventory details in response json
+   */
+  inventory?: boolean | undefined;
+};
+
+export type ListMarketplaceProductsContent = {
+  products: Array<components.Product>;
+  /**
+   * pagination metadata structure
+   */
+  pagination: components.Pagination;
+};
+
+/**
+ * Success response
+ */
+export type ListMarketplaceProductsResponseBody = {
+  message: string;
+  success: boolean;
+  content: ListMarketplaceProductsContent;
+};
+
+/** @internal */
+export type ListMarketplaceProductsRequest$Outbound = {
+  page?: number | undefined;
+  limit?: number | undefined;
+  sort_by?: string | undefined;
+  "x-customer-group-id"?: string | undefined;
+  category_id?: Array<string> | undefined;
+  category_slug?: Array<string> | undefined;
+  inventory?: boolean | undefined;
+};
+
+/** @internal */
+export const ListMarketplaceProductsRequest$outboundSchema: z.ZodType<
+  ListMarketplaceProductsRequest$Outbound,
+  z.ZodTypeDef,
+  ListMarketplaceProductsRequest
+> = z.object({
+  page: z.number().optional(),
+  limit: z.number().int().optional(),
+  sortBy: z.string().optional(),
+  xCustomerGroupId: z.string().optional(),
+  categoryId: z.array(z.string()).optional(),
+  categorySlug: z.array(z.string()).optional(),
+  inventory: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    sortBy: "sort_by",
+    xCustomerGroupId: "x-customer-group-id",
+    categoryId: "category_id",
+    categorySlug: "category_slug",
+  });
+});
+
+export function listMarketplaceProductsRequestToJSON(
+  listMarketplaceProductsRequest: ListMarketplaceProductsRequest,
+): string {
+  return JSON.stringify(
+    ListMarketplaceProductsRequest$outboundSchema.parse(
+      listMarketplaceProductsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListMarketplaceProductsContent$inboundSchema: z.ZodType<
+  ListMarketplaceProductsContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  products: z.array(components.Product$inboundSchema),
+  pagination: components.Pagination$inboundSchema,
+});
+
+export function listMarketplaceProductsContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ListMarketplaceProductsContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListMarketplaceProductsContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListMarketplaceProductsContent' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListMarketplaceProductsResponseBody$inboundSchema: z.ZodType<
+  ListMarketplaceProductsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  success: z.boolean(),
+  content: z.lazy(() => ListMarketplaceProductsContent$inboundSchema),
+});
+
+export function listMarketplaceProductsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListMarketplaceProductsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceProductsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListMarketplaceProductsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/listmarketplaceproductvariants.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListMarketplaceProductVariantsRequest = {
+  /**
+   * This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned.
+   */
+  xCustomerGroupId?: string | undefined;
+  /**
+   * Determines whether to include or exlude inventory details in response json
+   */
+  inventory?: boolean | undefined;
+  /**
+   * ID of a particular product
+   */
+  productId: string;
+};
+
+export type ListMarketplaceProductVariantsContent = {
+  variants: Array<components.Variant>;
+};
+
+/**
+ * Success response
+ */
+export type ListMarketplaceProductVariantsResponseBody = {
+  message: string;
+  success: boolean;
+  content: ListMarketplaceProductVariantsContent;
+};
+
+/** @internal */
+export type ListMarketplaceProductVariantsRequest$Outbound = {
+  "x-customer-group-id"?: string | undefined;
+  inventory?: boolean | undefined;
+  product_id: string;
+};
+
+/** @internal */
+export const ListMarketplaceProductVariantsRequest$outboundSchema: z.ZodType<
+  ListMarketplaceProductVariantsRequest$Outbound,
+  z.ZodTypeDef,
+  ListMarketplaceProductVariantsRequest
+> = z.object({
+  xCustomerGroupId: z.string().optional(),
+  inventory: z.boolean().optional(),
+  productId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    xCustomerGroupId: "x-customer-group-id",
+    productId: "product_id",
+  });
+});
+
+export function listMarketplaceProductVariantsRequestToJSON(
+  listMarketplaceProductVariantsRequest: ListMarketplaceProductVariantsRequest,
+): string {
+  return JSON.stringify(
+    ListMarketplaceProductVariantsRequest$outboundSchema.parse(
+      listMarketplaceProductVariantsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListMarketplaceProductVariantsContent$inboundSchema: z.ZodType<
+  ListMarketplaceProductVariantsContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  variants: z.array(components.Variant$inboundSchema),
+});
+
+export function listMarketplaceProductVariantsContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ListMarketplaceProductVariantsContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceProductVariantsContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListMarketplaceProductVariantsContent' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListMarketplaceProductVariantsResponseBody$inboundSchema:
+  z.ZodType<ListMarketplaceProductVariantsResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      message: z.string(),
+      success: z.boolean(),
+      content: z.lazy(() =>
+        ListMarketplaceProductVariantsContent$inboundSchema
+      ),
+    });
+
+export function listMarketplaceProductVariantsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListMarketplaceProductVariantsResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceProductVariantsResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListMarketplaceProductVariantsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/listmarketplacesimilarproducts.ts

@@ -0,0 +1,136 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListMarketplaceSimilarProductsRequest = {
+  /**
+   * This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned.
+   */
+  xCustomerGroupId?: string | undefined;
+  /**
+   * no of rows per page
+   */
+  limit?: number | undefined;
+  /**
+   * page number in pagination
+   */
+  page?: number | undefined;
+  /**
+   * to retrieve similar products of specified products
+   */
+  productId?: Array<string> | undefined;
+  /**
+   * json to sort records
+   */
+  sortBy?: string | undefined;
+};
+
+export type ListMarketplaceSimilarProductsContent = {
+  products: Array<components.Item>;
+  /**
+   * pagination metadata structure
+   */
+  pagination: components.Pagination;
+};
+
+/**
+ * Success response
+ */
+export type ListMarketplaceSimilarProductsResponseBody = {
+  message: string;
+  success: boolean;
+  content: ListMarketplaceSimilarProductsContent;
+};
+
+/** @internal */
+export type ListMarketplaceSimilarProductsRequest$Outbound = {
+  "x-customer-group-id"?: string | undefined;
+  limit?: number | undefined;
+  page?: number | undefined;
+  product_id?: Array<string> | undefined;
+  sort_by?: string | undefined;
+};
+
+/** @internal */
+export const ListMarketplaceSimilarProductsRequest$outboundSchema: z.ZodType<
+  ListMarketplaceSimilarProductsRequest$Outbound,
+  z.ZodTypeDef,
+  ListMarketplaceSimilarProductsRequest
+> = z.object({
+  xCustomerGroupId: z.string().optional(),
+  limit: z.number().int().optional(),
+  page: z.number().int().optional(),
+  productId: z.array(z.string()).optional(),
+  sortBy: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    xCustomerGroupId: "x-customer-group-id",
+    productId: "product_id",
+    sortBy: "sort_by",
+  });
+});
+
+export function listMarketplaceSimilarProductsRequestToJSON(
+  listMarketplaceSimilarProductsRequest: ListMarketplaceSimilarProductsRequest,
+): string {
+  return JSON.stringify(
+    ListMarketplaceSimilarProductsRequest$outboundSchema.parse(
+      listMarketplaceSimilarProductsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListMarketplaceSimilarProductsContent$inboundSchema: z.ZodType<
+  ListMarketplaceSimilarProductsContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  products: z.array(components.Item$inboundSchema),
+  pagination: components.Pagination$inboundSchema,
+});
+
+export function listMarketplaceSimilarProductsContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ListMarketplaceSimilarProductsContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceSimilarProductsContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListMarketplaceSimilarProductsContent' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListMarketplaceSimilarProductsResponseBody$inboundSchema:
+  z.ZodType<ListMarketplaceSimilarProductsResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      message: z.string(),
+      success: z.boolean(),
+      content: z.lazy(() =>
+        ListMarketplaceSimilarProductsContent$inboundSchema
+      ),
+    });
+
+export function listMarketplaceSimilarProductsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListMarketplaceSimilarProductsResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListMarketplaceSimilarProductsResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListMarketplaceSimilarProductsResponseBody' from JSON`,
+  );
+}