@shophost/rest-api 0.1.21 → 2.0.0

package/src/client/generated/sdk.gen.d.ts

@@ -0,0 +1,315 @@
+import type { Client, Options as Options2, TDataShape } from './client';
+import type { AccessEligibilityData, AccessEligibilityResponses, CreateManufacturerData, CreateManufacturerErrors, CreateManufacturerResponses, CreateOrderData, CreateOrderErrors, CreateOrderResponses, CreateOrganizationData, CreateOrganizationErrors, CreateOrganizationResponses, CreateProductCategoryData, CreateProductCategoryErrors, CreateProductCategoryResponses, CreateProductData, CreateProductErrors, CreateProductResponses, CreateReservationData, CreateReservationErrors, CreateReservationResponses, CreateShippingAddressData, CreateShippingAddressErrors, CreateShippingAddressResponses, CreateShippingMethodData, CreateShippingMethodErrors, CreateShippingMethodResponses, CreateTemporaryFileData, CreateTemporaryFileResponses, DeleteManufacturerData, DeleteManufacturerErrors, DeleteManufacturerResponses, DeleteOrderData, DeleteOrderErrors, DeleteOrderResponses, DeleteOrganizationData, DeleteOrganizationErrors, DeleteOrganizationResponses, DeleteProductCategoryData, DeleteProductCategoryErrors, DeleteProductCategoryResponses, DeleteProductData, DeleteProductErrors, DeleteProductResponses, DeleteReservationData, DeleteReservationErrors, DeleteReservationResponses, DeleteShippingMethodData, DeleteShippingMethodErrors, DeleteShippingMethodResponses, GetAvailablePaymentMethodsData, GetAvailablePaymentMethodsErrors, GetAvailablePaymentMethodsResponses, GetCartDataData, GetCartDataErrors, GetCartDataResponses, GetManufacturerData, GetManufacturerErrors, GetManufacturerResponses, GetManufacturersData, GetManufacturersErrors, GetManufacturersResponses, GetOrderData, GetOrderErrors, GetOrderResponses, GetOrdersData, GetOrdersErrors, GetOrdersResponses, GetOrganizationData, GetOrganizationErrors, GetOrganizationResponses, GetOrganizationsData, GetOrganizationsResponses, GetPlaceDetailsData, GetPlaceDetailsErrors, GetPlaceDetailsResponses, GetPredictionsData, GetPredictionsErrors, GetPredictionsResponses, GetProductCategoriesData, GetProductCategoriesErrors, GetProductCategoriesResponses, GetProductCategoryData, GetProductCategoryErrors, GetProductCategoryResponses, GetProductData, GetProductErrors, GetProductResponses, GetProductsByCategoryData, GetProductsByCategoryErrors, GetProductsByCategoryResponses, GetProductsData, GetProductsErrors, GetProductsResponses, GetReservationData, GetReservationErrors, GetReservationResponses, GetReservationsData, GetReservationsErrors, GetReservationsResponses, GetShippingAddressData, GetShippingAddressErrors, GetShippingAddressResponses, GetShippingMethodData, GetShippingMethodErrors, GetShippingMethodResponses, GetShippingMethodsData, GetShippingMethodsErrors, GetShippingMethodsResponses, GetUserReservationsData, GetUserReservationsErrors, GetUserReservationsResponses, GetVercelTokenData, GetVercelTokenResponses, PingData, PingErrors, PingResponses, UpdateManufacturerData, UpdateManufacturerErrors, UpdateManufacturerResponses, UpdateOrderStatusData, UpdateOrderStatusErrors, UpdateOrderStatusResponses, UpdateOrganizationData, UpdateOrganizationErrors, UpdateOrganizationResponses, UpdateProductCategoryData, UpdateProductCategoryErrors, UpdateProductCategoryResponses, UpdateProductCategoryStatusData, UpdateProductCategoryStatusErrors, UpdateProductCategoryStatusResponses, UpdateProductData, UpdateProductErrors, UpdateProductResponses, UpdateProductStatusData, UpdateProductStatusErrors, UpdateProductStatusResponses, UpdateReservationStatusData, UpdateReservationStatusErrors, UpdateReservationStatusResponses, UpdateShippingAddressData, UpdateShippingAddressErrors, UpdateShippingAddressResponses, UpdateShippingMethodData, UpdateShippingMethodErrors, UpdateShippingMethodResponses, WebhookData, WebhookErrors, WebhookResponses } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Ping
+ *
+ * Pings the relevancy score service to check its availability
+ */
+export declare const ping: <ThrowOnError extends boolean = false>(options?: Options<PingData, ThrowOnError>) => import("./client").RequestResult<PingResponses, PingErrors, ThrowOnError, "fields">;
+/**
+ * Get Manufacturers
+ *
+ * Fetches a paginated list of manufacturers for a specific organization
+ */
+export declare const getManufacturers: <ThrowOnError extends boolean = false>(options: Options<GetManufacturersData, ThrowOnError>) => import("./client").RequestResult<GetManufacturersResponses, GetManufacturersErrors, ThrowOnError, "fields">;
+/**
+ * Create Manufacturer
+ *
+ * Creates a new manufacturer for a specific organization
+ */
+export declare const createManufacturer: <ThrowOnError extends boolean = false>(options: Options<CreateManufacturerData, ThrowOnError>) => import("./client").RequestResult<CreateManufacturerResponses, CreateManufacturerErrors, ThrowOnError, "fields">;
+/**
+ * Delete Manufacturer
+ *
+ * Soft deletes a manufacturer
+ */
+export declare const deleteManufacturer: <ThrowOnError extends boolean = false>(options: Options<DeleteManufacturerData, ThrowOnError>) => import("./client").RequestResult<DeleteManufacturerResponses, DeleteManufacturerErrors, ThrowOnError, "fields">;
+/**
+ * Get Manufacturer
+ */
+export declare const getManufacturer: <ThrowOnError extends boolean = false>(options: Options<GetManufacturerData, ThrowOnError>) => import("./client").RequestResult<GetManufacturerResponses, GetManufacturerErrors, ThrowOnError, "fields">;
+/**
+ * Update Manufacturer
+ *
+ * Updates an existing manufacturer
+ */
+export declare const updateManufacturer: <ThrowOnError extends boolean = false>(options: Options<UpdateManufacturerData, ThrowOnError>) => import("./client").RequestResult<UpdateManufacturerResponses, UpdateManufacturerErrors, ThrowOnError, "fields">;
+/**
+ * Get Organizations
+ *
+ * Fetches a paginated list of organizations
+ */
+export declare const getOrganizations: <ThrowOnError extends boolean = false>(options?: Options<GetOrganizationsData, ThrowOnError>) => import("./client").RequestResult<GetOrganizationsResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Create Organization
+ *
+ * Creates a new organization
+ */
+export declare const createOrganization: <ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>) => import("./client").RequestResult<CreateOrganizationResponses, CreateOrganizationErrors, ThrowOnError, "fields">;
+/**
+ * Delete Organization
+ *
+ * Deletes a specific organization by ID
+ */
+export declare const deleteOrganization: <ThrowOnError extends boolean = false>(options: Options<DeleteOrganizationData, ThrowOnError>) => import("./client").RequestResult<DeleteOrganizationResponses, DeleteOrganizationErrors, ThrowOnError, "fields">;
+/**
+ * Get Organization
+ *
+ * Fetches a specific organization by ID
+ */
+export declare const getOrganization: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationData, ThrowOnError>) => import("./client").RequestResult<GetOrganizationResponses, GetOrganizationErrors, ThrowOnError, "fields">;
+/**
+ * Update Organization
+ *
+ * Updates a specific organization by ID
+ */
+export declare const updateOrganization: <ThrowOnError extends boolean = false>(options: Options<UpdateOrganizationData, ThrowOnError>) => import("./client").RequestResult<UpdateOrganizationResponses, UpdateOrganizationErrors, ThrowOnError, "fields">;
+/**
+ * Get Vercel Token
+ *
+ * Returns a Vercel token
+ */
+export declare const getVercelToken: <ThrowOnError extends boolean = false>(options: Options<GetVercelTokenData, ThrowOnError>) => import("./client").RequestResult<GetVercelTokenResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Create Temporary File
+ *
+ * Creates a temporary file record and returns its ID
+ */
+export declare const createTemporaryFile: <ThrowOnError extends boolean = false>(options: Options<CreateTemporaryFileData, ThrowOnError>) => import("./client").RequestResult<CreateTemporaryFileResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Product Categories
+ *
+ * Fetches a paginated list of product categories for a specific organization
+ */
+export declare const getProductCategories: <ThrowOnError extends boolean = false>(options: Options<GetProductCategoriesData, ThrowOnError>) => import("./client").RequestResult<GetProductCategoriesResponses, GetProductCategoriesErrors, ThrowOnError, "fields">;
+/**
+ * Create Product Category
+ *
+ * Creates a new product category for a specific organization
+ */
+export declare const createProductCategory: <ThrowOnError extends boolean = false>(options: Options<CreateProductCategoryData, ThrowOnError>) => import("./client").RequestResult<CreateProductCategoryResponses, CreateProductCategoryErrors, ThrowOnError, "fields">;
+/**
+ * Delete Product Category
+ *
+ * Deletes a specific product category by ID
+ */
+export declare const deleteProductCategory: <ThrowOnError extends boolean = false>(options: Options<DeleteProductCategoryData, ThrowOnError>) => import("./client").RequestResult<DeleteProductCategoryResponses, DeleteProductCategoryErrors, ThrowOnError, "fields">;
+/**
+ * Get Product Category
+ *
+ * Fetches a specific product category by ID
+ */
+export declare const getProductCategory: <ThrowOnError extends boolean = false>(options: Options<GetProductCategoryData, ThrowOnError>) => import("./client").RequestResult<GetProductCategoryResponses, GetProductCategoryErrors, ThrowOnError, "fields">;
+/**
+ * Update Product Category
+ *
+ * Updates a specific product category by ID
+ */
+export declare const updateProductCategory: <ThrowOnError extends boolean = false>(options: Options<UpdateProductCategoryData, ThrowOnError>) => import("./client").RequestResult<UpdateProductCategoryResponses, UpdateProductCategoryErrors, ThrowOnError, "fields">;
+/**
+ * Publish or Unpublish Product Category
+ *
+ * Sets the published status of an existing product category based on the operation (publish or unpublish)
+ */
+export declare const updateProductCategoryStatus: <ThrowOnError extends boolean = false>(options: Options<UpdateProductCategoryStatusData, ThrowOnError>) => import("./client").RequestResult<UpdateProductCategoryStatusResponses, UpdateProductCategoryStatusErrors, ThrowOnError, "fields">;
+/**
+ * Get Products
+ *
+ * Fetches paginated list of products
+ */
+export declare const getProducts: <ThrowOnError extends boolean = false>(options: Options<GetProductsData, ThrowOnError>) => import("./client").RequestResult<GetProductsResponses, GetProductsErrors, ThrowOnError, "fields">;
+/**
+ * Create Product
+ *
+ * Creates a new product
+ */
+export declare const createProduct: <ThrowOnError extends boolean = false>(options: Options<CreateProductData, ThrowOnError>) => import("./client").RequestResult<CreateProductResponses, CreateProductErrors, ThrowOnError, "fields">;
+/**
+ * Delete Product
+ *
+ * Deletes a specific product by ID
+ */
+export declare const deleteProduct: <ThrowOnError extends boolean = false>(options: Options<DeleteProductData, ThrowOnError>) => import("./client").RequestResult<DeleteProductResponses, DeleteProductErrors, ThrowOnError, "fields">;
+/**
+ * Get Product
+ *
+ * Fetches a specific product by ID
+ */
+export declare const getProduct: <ThrowOnError extends boolean = false>(options: Options<GetProductData, ThrowOnError>) => import("./client").RequestResult<GetProductResponses, GetProductErrors, ThrowOnError, "fields">;
+/**
+ * Update Product
+ *
+ * Updates a specific product by ID
+ */
+export declare const updateProduct: <ThrowOnError extends boolean = false>(options: Options<UpdateProductData, ThrowOnError>) => import("./client").RequestResult<UpdateProductResponses, UpdateProductErrors, ThrowOnError, "fields">;
+/**
+ * Publish or Unpublish Product
+ *
+ * Sets the published status of an existing product based on the operation (publish or unpublish)
+ */
+export declare const updateProductStatus: <ThrowOnError extends boolean = false>(options: Options<UpdateProductStatusData, ThrowOnError>) => import("./client").RequestResult<UpdateProductStatusResponses, UpdateProductStatusErrors, ThrowOnError, "fields">;
+/**
+ * Get Products by Category
+ *
+ * Fetches a paginated list of products for a specific category
+ */
+export declare const getProductsByCategory: <ThrowOnError extends boolean = false>(options: Options<GetProductsByCategoryData, ThrowOnError>) => import("./client").RequestResult<GetProductsByCategoryResponses, GetProductsByCategoryErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipping Methods
+ *
+ * Fetches a paginated list of shipping methods for an organization
+ */
+export declare const getShippingMethods: <ThrowOnError extends boolean = false>(options: Options<GetShippingMethodsData, ThrowOnError>) => import("./client").RequestResult<GetShippingMethodsResponses, GetShippingMethodsErrors, ThrowOnError, "fields">;
+/**
+ * Create Shipping Method
+ *
+ * Creates a new shipping method for an organization
+ */
+export declare const createShippingMethod: <ThrowOnError extends boolean = false>(options: Options<CreateShippingMethodData, ThrowOnError>) => import("./client").RequestResult<CreateShippingMethodResponses, CreateShippingMethodErrors, ThrowOnError, "fields">;
+/**
+ * Delete Shipping Method
+ *
+ * Soft deletes a shipping method
+ */
+export declare const deleteShippingMethod: <ThrowOnError extends boolean = false>(options: Options<DeleteShippingMethodData, ThrowOnError>) => import("./client").RequestResult<DeleteShippingMethodResponses, DeleteShippingMethodErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipping Method
+ */
+export declare const getShippingMethod: <ThrowOnError extends boolean = false>(options: Options<GetShippingMethodData, ThrowOnError>) => import("./client").RequestResult<GetShippingMethodResponses, GetShippingMethodErrors, ThrowOnError, "fields">;
+/**
+ * Update Shipping Method
+ *
+ * Updates an existing shipping method
+ */
+export declare const updateShippingMethod: <ThrowOnError extends boolean = false>(options: Options<UpdateShippingMethodData, ThrowOnError>) => import("./client").RequestResult<UpdateShippingMethodResponses, UpdateShippingMethodErrors, ThrowOnError, "fields">;
+/**
+ * Get Eligible Shipping Methods
+ *
+ * Fetches a list of published shipping methods a user can use
+ */
+export declare const accessEligibility: <ThrowOnError extends boolean = false>(options: Options<AccessEligibilityData, ThrowOnError>) => import("./client").RequestResult<AccessEligibilityResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Orders
+ *
+ * Fetches paginated list of orders
+ */
+export declare const getOrders: <ThrowOnError extends boolean = false>(options: Options<GetOrdersData, ThrowOnError>) => import("./client").RequestResult<GetOrdersResponses, GetOrdersErrors, ThrowOnError, "fields">;
+/**
+ * Create Order
+ *
+ * Creates a new order
+ */
+export declare const createOrder: <ThrowOnError extends boolean = false>(options: Options<CreateOrderData, ThrowOnError>) => import("./client").RequestResult<CreateOrderResponses, CreateOrderErrors, ThrowOnError, "fields">;
+/**
+ * Delete Order
+ *
+ * Soft deletes order
+ */
+export declare const deleteOrder: <ThrowOnError extends boolean = false>(options: Options<DeleteOrderData, ThrowOnError>) => import("./client").RequestResult<DeleteOrderResponses, DeleteOrderErrors, ThrowOnError, "fields">;
+/**
+ * Get Order
+ */
+export declare const getOrder: <ThrowOnError extends boolean = false>(options: Options<GetOrderData, ThrowOnError>) => import("./client").RequestResult<GetOrderResponses, GetOrderErrors, ThrowOnError, "fields">;
+/**
+ * Change Order Status
+ *
+ * Changes the status of an existing order based on the operation
+ */
+export declare const updateOrderStatus: <ThrowOnError extends boolean = false>(options: Options<UpdateOrderStatusData, ThrowOnError>) => import("./client").RequestResult<UpdateOrderStatusResponses, UpdateOrderStatusErrors, ThrowOnError, "fields">;
+/**
+ * Get Formatted Cart
+ *
+ * Fetches formatted cart data
+ */
+export declare const getCartData: <ThrowOnError extends boolean = false>(options: Options<GetCartDataData, ThrowOnError>) => import("./client").RequestResult<GetCartDataResponses, GetCartDataErrors, ThrowOnError, "fields">;
+/**
+ * Get Shipping Address
+ *
+ * Get the default shipping address for the user
+ */
+export declare const getShippingAddress: <ThrowOnError extends boolean = false>(options?: Options<GetShippingAddressData, ThrowOnError>) => import("./client").RequestResult<GetShippingAddressResponses, GetShippingAddressErrors, ThrowOnError, "fields">;
+/**
+ * Create Shipping Address
+ *
+ * Creates a new shipping address for the user
+ */
+export declare const createShippingAddress: <ThrowOnError extends boolean = false>(options: Options<CreateShippingAddressData, ThrowOnError>) => import("./client").RequestResult<CreateShippingAddressResponses, CreateShippingAddressErrors, ThrowOnError, "fields">;
+/**
+ * Update Shipping Address
+ *
+ * Updates the shipping address for the user
+ */
+export declare const updateShippingAddress: <ThrowOnError extends boolean = false>(options: Options<UpdateShippingAddressData, ThrowOnError>) => import("./client").RequestResult<UpdateShippingAddressResponses, UpdateShippingAddressErrors, ThrowOnError, "fields">;
+/**
+ * Get Places Predictions
+ *
+ * Returns a list of places for autocompletion based on a search query
+ */
+export declare const getPredictions: <ThrowOnError extends boolean = false>(options: Options<GetPredictionsData, ThrowOnError>) => import("./client").RequestResult<GetPredictionsResponses, GetPredictionsErrors, ThrowOnError, "fields">;
+/**
+ * Get Place Details
+ *
+ * Returns details for a specific place based on its placeId
+ */
+export declare const getPlaceDetails: <ThrowOnError extends boolean = false>(options: Options<GetPlaceDetailsData, ThrowOnError>) => import("./client").RequestResult<GetPlaceDetailsResponses, GetPlaceDetailsErrors, ThrowOnError, "fields">;
+/**
+ * Get Available Payment Methods
+ *
+ * Returns a list of available payment methods for the organization.
+ */
+export declare const getAvailablePaymentMethods: <ThrowOnError extends boolean = false>(options: Options<GetAvailablePaymentMethodsData, ThrowOnError>) => import("./client").RequestResult<GetAvailablePaymentMethodsResponses, GetAvailablePaymentMethodsErrors, ThrowOnError, "fields">;
+/**
+ * Process Event
+ *
+ * Receive webhook events from payment providers
+ */
+export declare const webhook: <ThrowOnError extends boolean = false>(options: Options<WebhookData, ThrowOnError>) => import("./client").RequestResult<WebhookResponses, WebhookErrors, ThrowOnError, "fields">;
+/**
+ * Get Reservations
+ *
+ * Get all reservations for an organization
+ */
+export declare const getReservations: <ThrowOnError extends boolean = false>(options: Options<GetReservationsData, ThrowOnError>) => import("./client").RequestResult<GetReservationsResponses, GetReservationsErrors, ThrowOnError, "fields">;
+/**
+ * Create Reservation
+ *
+ * Create a new reservation
+ */
+export declare const createReservation: <ThrowOnError extends boolean = false>(options: Options<CreateReservationData, ThrowOnError>) => import("./client").RequestResult<CreateReservationResponses, CreateReservationErrors, ThrowOnError, "fields">;
+/**
+ * Delete Reservation
+ *
+ * Delete a reservation
+ */
+export declare const deleteReservation: <ThrowOnError extends boolean = false>(options: Options<DeleteReservationData, ThrowOnError>) => import("./client").RequestResult<DeleteReservationResponses, DeleteReservationErrors, ThrowOnError, "fields">;
+/**
+ * Get Reservation
+ *
+ * Get a specific reservation by ID
+ */
+export declare const getReservation: <ThrowOnError extends boolean = false>(options: Options<GetReservationData, ThrowOnError>) => import("./client").RequestResult<GetReservationResponses, GetReservationErrors, ThrowOnError, "fields">;
+/**
+ * Get User Reservations
+ *
+ * Get all reservations for a user
+ */
+export declare const getUserReservations: <ThrowOnError extends boolean = false>(options: Options<GetUserReservationsData, ThrowOnError>) => import("./client").RequestResult<GetUserReservationsResponses, GetUserReservationsErrors, ThrowOnError, "fields">;
+/**
+ * Update Reservation Status
+ *
+ * Update the status of a reservation
+ */
+export declare const updateReservationStatus: <ThrowOnError extends boolean = false>(options: Options<UpdateReservationStatusData, ThrowOnError>) => import("./client").RequestResult<UpdateReservationStatusResponses, UpdateReservationStatusErrors, ThrowOnError, "fields">;