ce-storefront 0.7.3 → 0.8.1

package/docs/sdks/shipping/README.md

@@ -1,85 +0,0 @@
-# Shipping
-(*shipping*)
-
-## Overview
-
-### Available Operations
-
-* [checkDeliveryAvailability](#checkdeliveryavailability) - Check pincode deliverability
-
-## checkDeliveryAvailability
-
-Check shipment delivery availability in an area by pincode
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.shipping.checkDeliveryAvailability({
-    pincode: "144552",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { shippingCheckDeliveryAvailability } from "ce-storefront/funcs/shippingCheckDeliveryAvailability.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await shippingCheckDeliveryAvailability(ceStorefront, {
-    pincode: "144552",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CheckDeliveryAvailabilityRequest](../../models/operations/checkdeliveryavailabilityrequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.CheckDeliveryAvailabilityResponseBody](../../models/operations/checkdeliveryavailabilityresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/src/funcs/catalogCreateProductReview.ts

@@ -1,161 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { CeStorefrontCore } from "../core.js";
-import { appendForm, 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 { CeError } from "../models/errors/ceerror.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import * as operations from "../models/operations/index.js";
-import { Result } from "../types/fp.js";
-
-/**
- * Create product review
- *
- * @remarks
- * Create a product review
- */
-export async function catalogCreateProductReview(
-  client: CeStorefrontCore,
-  request: operations.CreateProductReviewRequest,
-  options?: RequestOptions,
-): Promise<
-  Result<
-    operations.CreateProductReviewResponseBody,
-    | errors.BadRequest
-    | errors.Unauthorized
-    | errors.NotFound
-    | CeError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.CreateProductReviewRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return parsed;
-  }
-  const payload = parsed.value;
-  const body = new FormData();
-
-  appendForm(body, "order_number", payload.CreateReview.order_number);
-  appendForm(body, "rating", payload.CreateReview.rating);
-  appendForm(body, "user_id", payload.CreateReview.user_id);
-  if (payload.CreateReview.images !== undefined) {
-    appendForm(body, "images", payload.CreateReview.images);
-  }
-  if (payload.CreateReview.review_text !== undefined) {
-    appendForm(body, "review_text", payload.CreateReview.review_text);
-  }
-  if (payload.CreateReview.videos !== undefined) {
-    appendForm(body, "videos", payload.CreateReview.videos);
-  }
-
-  const pathParams = {
-    product_id: encodeSimple("product_id", payload.product_id, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
-
-  const path = pathToFunc("/catalog/products/{product_id}/reviews")(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 = {
-    baseURL: options?.serverURL ?? "",
-    operationID: "create-product-review",
-    oAuth2Scopes: [],
-
-    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: "POST",
-    baseURL: options?.serverURL,
-    path: path,
-    headers: headers,
-    body: body,
-    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return requestRes;
-  }
-  const req = requestRes.value;
-
-  const doResult = await client._do(req, {
-    context,
-    errorCodes: ["400", "401", "404", "4XX", "5XX"],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return doResult;
-  }
-  const response = doResult.value;
-
-  const responseFields = {
-    HttpMeta: { Response: response, Request: req },
-  };
-
-  const [result] = await M.match<
-    operations.CreateProductReviewResponseBody,
-    | errors.BadRequest
-    | errors.Unauthorized
-    | errors.NotFound
-    | CeError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >(
-    M.json(200, operations.CreateProductReviewResponseBody$inboundSchema),
-    M.jsonErr(400, errors.BadRequest$inboundSchema),
-    M.jsonErr(401, errors.Unauthorized$inboundSchema),
-    M.jsonErr(404, errors.NotFound$inboundSchema),
-    M.fail("4XX"),
-    M.fail("5XX"),
-  )(response, { extraFields: responseFields });
-  if (!result.ok) {
-    return result;
-  }
-
-  return result;
-}

package/src/models/components/createreview.ts

@@ -1,98 +0,0 @@
-/*
- * 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";
-
-/**
- * Create Product Review model
- */
-export type CreateReview = {
-  orderNumber: string;
-  rating: number;
-  userId: string;
-  images?: Array<string> | undefined;
-  reviewText?: string | undefined;
-  videos?: Array<string> | undefined;
-};
-
-/** @internal */
-export const CreateReview$inboundSchema: z.ZodType<
-  CreateReview,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  order_number: z.string(),
-  rating: z.number(),
-  user_id: z.string(),
-  images: z.array(z.string()).optional(),
-  review_text: z.string().optional(),
-  videos: z.array(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "order_number": "orderNumber",
-    "user_id": "userId",
-    "review_text": "reviewText",
-  });
-});
-
-/** @internal */
-export type CreateReview$Outbound = {
-  order_number: string;
-  rating: number;
-  user_id: string;
-  images?: Array<string> | undefined;
-  review_text?: string | undefined;
-  videos?: Array<string> | undefined;
-};
-
-/** @internal */
-export const CreateReview$outboundSchema: z.ZodType<
-  CreateReview$Outbound,
-  z.ZodTypeDef,
-  CreateReview
-> = z.object({
-  orderNumber: z.string(),
-  rating: z.number(),
-  userId: z.string(),
-  images: z.array(z.string()).optional(),
-  reviewText: z.string().optional(),
-  videos: z.array(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    orderNumber: "order_number",
-    userId: "user_id",
-    reviewText: "review_text",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreateReview$ {
-  /** @deprecated use `CreateReview$inboundSchema` instead. */
-  export const inboundSchema = CreateReview$inboundSchema;
-  /** @deprecated use `CreateReview$outboundSchema` instead. */
-  export const outboundSchema = CreateReview$outboundSchema;
-  /** @deprecated use `CreateReview$Outbound` instead. */
-  export type Outbound = CreateReview$Outbound;
-}
-
-export function createReviewToJSON(createReview: CreateReview): string {
-  return JSON.stringify(CreateReview$outboundSchema.parse(createReview));
-}
-
-export function createReviewFromJSON(
-  jsonString: string,
-): SafeParseResult<CreateReview, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreateReview$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateReview' from JSON`,
-  );
-}

package/src/models/operations/createproductreview.ts

@@ -1,152 +0,0 @@
-/*
- * 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 * as components from "../components/index.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export type CreateProductReviewRequest = {
-  /**
-   * id of a particular product
-   */
-  productId: string;
-  createReview: components.CreateReview;
-};
-
-/**
- * Success response
- */
-export type CreateProductReviewResponseBody = {
-  message: string;
-  success: boolean;
-};
-
-/** @internal */
-export const CreateProductReviewRequest$inboundSchema: z.ZodType<
-  CreateProductReviewRequest,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  product_id: z.string(),
-  CreateReview: components.CreateReview$inboundSchema,
-}).transform((v) => {
-  return remap$(v, {
-    "product_id": "productId",
-    "CreateReview": "createReview",
-  });
-});
-
-/** @internal */
-export type CreateProductReviewRequest$Outbound = {
-  product_id: string;
-  CreateReview: components.CreateReview$Outbound;
-};
-
-/** @internal */
-export const CreateProductReviewRequest$outboundSchema: z.ZodType<
-  CreateProductReviewRequest$Outbound,
-  z.ZodTypeDef,
-  CreateProductReviewRequest
-> = z.object({
-  productId: z.string(),
-  createReview: components.CreateReview$outboundSchema,
-}).transform((v) => {
-  return remap$(v, {
-    productId: "product_id",
-    createReview: "CreateReview",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreateProductReviewRequest$ {
-  /** @deprecated use `CreateProductReviewRequest$inboundSchema` instead. */
-  export const inboundSchema = CreateProductReviewRequest$inboundSchema;
-  /** @deprecated use `CreateProductReviewRequest$outboundSchema` instead. */
-  export const outboundSchema = CreateProductReviewRequest$outboundSchema;
-  /** @deprecated use `CreateProductReviewRequest$Outbound` instead. */
-  export type Outbound = CreateProductReviewRequest$Outbound;
-}
-
-export function createProductReviewRequestToJSON(
-  createProductReviewRequest: CreateProductReviewRequest,
-): string {
-  return JSON.stringify(
-    CreateProductReviewRequest$outboundSchema.parse(createProductReviewRequest),
-  );
-}
-
-export function createProductReviewRequestFromJSON(
-  jsonString: string,
-): SafeParseResult<CreateProductReviewRequest, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreateProductReviewRequest$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateProductReviewRequest' from JSON`,
-  );
-}
-
-/** @internal */
-export const CreateProductReviewResponseBody$inboundSchema: z.ZodType<
-  CreateProductReviewResponseBody,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  message: z.string(),
-  success: z.boolean(),
-});
-
-/** @internal */
-export type CreateProductReviewResponseBody$Outbound = {
-  message: string;
-  success: boolean;
-};
-
-/** @internal */
-export const CreateProductReviewResponseBody$outboundSchema: z.ZodType<
-  CreateProductReviewResponseBody$Outbound,
-  z.ZodTypeDef,
-  CreateProductReviewResponseBody
-> = z.object({
-  message: z.string(),
-  success: z.boolean(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreateProductReviewResponseBody$ {
-  /** @deprecated use `CreateProductReviewResponseBody$inboundSchema` instead. */
-  export const inboundSchema = CreateProductReviewResponseBody$inboundSchema;
-  /** @deprecated use `CreateProductReviewResponseBody$outboundSchema` instead. */
-  export const outboundSchema = CreateProductReviewResponseBody$outboundSchema;
-  /** @deprecated use `CreateProductReviewResponseBody$Outbound` instead. */
-  export type Outbound = CreateProductReviewResponseBody$Outbound;
-}
-
-export function createProductReviewResponseBodyToJSON(
-  createProductReviewResponseBody: CreateProductReviewResponseBody,
-): string {
-  return JSON.stringify(
-    CreateProductReviewResponseBody$outboundSchema.parse(
-      createProductReviewResponseBody,
-    ),
-  );
-}
-
-export function createProductReviewResponseBodyFromJSON(
-  jsonString: string,
-): SafeParseResult<CreateProductReviewResponseBody, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreateProductReviewResponseBody$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateProductReviewResponseBody' from JSON`,
-  );
-}