@arascreative/erp-client 3.2.0 → 3.4.0

package/dist/generated/api.d.ts

@@ -968,6 +968,167 @@ export type CreateBatch409 = {
     instance?: string;
     errors?: CreateBatch409Errors;
 };
+export type CreateProductBodyCatalogVariantsItemAttributesItem = {
+    name: string;
+    value: string;
+};
+export type CreateProductBodyCatalogVariantsItemSourcesItem = {
+    warehouseId: string;
+    masterItemId: string;
+    quantityPerUnit: number;
+};
+export type CreateProductBodyCatalogVariantsItemWeightAnyOf = {
+    value: number;
+    unit: string;
+};
+export type CreateProductBodyCatalogVariantsItemWeight = CreateProductBodyCatalogVariantsItemWeightAnyOf | null;
+export type CreateProductBodyCatalogVariantsItemPricingSaleAnyOf = {
+    amount: number;
+    currency: string;
+    startAt: string;
+    endAt: string;
+};
+export type CreateProductBodyCatalogVariantsItemPricingSale = CreateProductBodyCatalogVariantsItemPricingSaleAnyOf | null;
+export type CreateProductBodyCatalogVariantsItemPricingWholesaleItem = {
+    minQty: number;
+    amount: number;
+    currency: string;
+};
+export type CreateProductBodyCatalogVariantsItemPricing = {
+    baseAmount: number;
+    baseCurrency: string;
+    sale?: CreateProductBodyCatalogVariantsItemPricingSale;
+    wholesale: CreateProductBodyCatalogVariantsItemPricingWholesaleItem[];
+};
+export type CreateProductBodyCatalogVariantsItem = {
+    code: string;
+    attributes: CreateProductBodyCatalogVariantsItemAttributesItem[];
+    sources: CreateProductBodyCatalogVariantsItemSourcesItem[];
+    weight?: CreateProductBodyCatalogVariantsItemWeight;
+    pricing: CreateProductBodyCatalogVariantsItemPricing;
+};
+export type CreateProductBodyCatalogImagesItem = {
+    fileId: string;
+    sortOrder: number;
+};
+export type CreateProductBodyCatalog = {
+    categoryId: string;
+    name: string;
+    slug: string;
+    classification: string;
+    variants: CreateProductBodyCatalogVariantsItem[];
+    images: CreateProductBodyCatalogImagesItem[];
+};
+export type CreateProductBodyShippingServicesItem = {
+    code: string;
+    enabled: boolean;
+    couriers: string[];
+};
+export type CreateProductBodyShippingDiscount = unknown | null;
+export type CreateProductBodyShippingDisplay = {
+    mergeExtraFee: boolean;
+    showOriginalPrice: boolean;
+    hideCouriers: boolean;
+    hideOrigin: boolean;
+};
+export type CreateProductBodyShippingCoverageCheck = {
+    enabled: boolean;
+    onUncovered: string;
+};
+export type CreateProductBodyShipping = {
+    mode: string;
+    flatAmount: number;
+    useStoreDefaults: boolean;
+    services: CreateProductBodyShippingServicesItem[];
+    extraFee: number;
+    discount?: CreateProductBodyShippingDiscount;
+    display: CreateProductBodyShippingDisplay;
+    coverageCheck: CreateProductBodyShippingCoverageCheck;
+};
+export type CreateProductBodyPaymentsTax = {
+    enabled: boolean;
+    ratePercent: number;
+    priceIncludesTax: boolean;
+};
+export type CreateProductBodyPayments = {
+    useStoreDefaults: boolean;
+    methods: unknown[];
+    tax: CreateProductBodyPaymentsTax;
+};
+export type CreateProductBodyAssignmentMembersItem = {
+    userId: string;
+    value: number;
+};
+export type CreateProductBodyAssignment = {
+    distribution: string;
+    members: CreateProductBodyAssignmentMembersItem[];
+};
+export type CreateProductBody = {
+    requestedStatus: string;
+    catalog: CreateProductBodyCatalog;
+    shipping: CreateProductBodyShipping;
+    payments: CreateProductBodyPayments;
+    assignment: CreateProductBodyAssignment;
+};
+export type CreateProduct201 = {
+    id: string;
+};
+export type CreateProduct400Errors = {
+    [key: string]: string[];
+};
+export type CreateProduct400 = {
+    type: string;
+    title: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+    errors?: CreateProduct400Errors;
+};
+export type CreateProduct501Errors = {
+    [key: string]: string[];
+};
+export type CreateProduct501 = {
+    type: string;
+    title: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+    errors?: CreateProduct501Errors;
+};
+export type ListProducts200ItemPrimaryImageUrl = string | null;
+export type ListProducts200Item = {
+    id: string;
+    name: string;
+    primaryImageUrl: ListProducts200ItemPrimaryImageUrl;
+    price: number;
+    availableStock: number;
+    totalOrders: number;
+    totalClosedOrders: number;
+    closedRatioPct: number;
+    totalCompletedOrder: number;
+    netRevenue: number;
+};
+export type ListProducts501Errors = {
+    [key: string]: string[];
+};
+export type ListProducts501 = {
+    type: string;
+    title: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+    errors?: ListProducts501Errors;
+};
+export type ListCouriers200Item = {
+    code: string;
+    name: string;
+    services: string[];
+};
+export type ListBankCodes200ItemName = string | null;
+export type ListBankCodes200Item = {
+    code: string;
+    name: ListBankCodes200ItemName;
+};
 export type GetHealth200 = {
     status: string;
     timestamp: string;
@@ -2278,6 +2439,221 @@ export declare const useCreateBatch: <TError = CreateBatch400 | CreateBatch404 |
 }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createBatch>>, TError, {
     data: CreateBatchBody;
 }, TContext>;
+/**
+ * Product setup contract covering catalog, shipping, payments, and assignment. Valid requestedStatus values: Tes, Live, Archived. Valid catalog.classification values: Physical, Digital. Not implemented yet.
+ * @summary Create a product
+ */
+export type createProductResponse201 = {
+    data: CreateProduct201;
+    status: 201;
+};
+export type createProductResponse400 = {
+    data: CreateProduct400;
+    status: 400;
+};
+export type createProductResponse501 = {
+    data: CreateProduct501;
+    status: 501;
+};
+export type createProductResponseSuccess = (createProductResponse201) & {
+    headers: Headers;
+};
+export type createProductResponseError = (createProductResponse400 | createProductResponse501) & {
+    headers: Headers;
+};
+export type createProductResponse = (createProductResponseSuccess | createProductResponseError);
+export declare const getCreateProductUrl: () => string;
+export declare const createProduct: (createProductBody: CreateProductBody, options?: RequestInit) => Promise<createProductResponse>;
+export declare const getCreateProductMutationOptions: <TError = CreateProduct400 | CreateProduct501, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createProduct>>, TError, {
+        data: CreateProductBody;
+    }, TContext>;
+    fetch?: RequestInit;
+}) => UseMutationOptions<Awaited<ReturnType<typeof createProduct>>, TError, {
+    data: CreateProductBody;
+}, TContext>;
+export type CreateProductMutationResult = NonNullable<Awaited<ReturnType<typeof createProduct>>>;
+export type CreateProductMutationBody = CreateProductBody;
+export type CreateProductMutationError = CreateProduct400 | CreateProduct501;
+/**
+* @summary Create a product
+*/
+export declare const useCreateProduct: <TError = CreateProduct400 | CreateProduct501, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createProduct>>, TError, {
+        data: CreateProductBody;
+    }, TContext>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createProduct>>, TError, {
+    data: CreateProductBody;
+}, TContext>;
+/**
+ * Product list contract with stock, order, and revenue metrics. Not implemented yet.
+ * @summary List products
+ */
+export type listProductsResponse200 = {
+    data: ListProducts200Item[];
+    status: 200;
+};
+export type listProductsResponse501 = {
+    data: ListProducts501;
+    status: 501;
+};
+export type listProductsResponseSuccess = (listProductsResponse200) & {
+    headers: Headers;
+};
+export type listProductsResponseError = (listProductsResponse501) & {
+    headers: Headers;
+};
+export type listProductsResponse = (listProductsResponseSuccess | listProductsResponseError);
+export declare const getListProductsUrl: () => string;
+export declare const listProducts: (options?: RequestInit) => Promise<listProductsResponse>;
+export declare const getListProductsQueryKey: () => readonly ["/api/v1/products"];
+export declare const getListProductsQueryOptions: <TData = Awaited<ReturnType<typeof listProducts>>, TError = ListProducts501>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listProducts>>, TError, TData>>;
+    fetch?: RequestInit;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listProducts>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListProductsQueryResult = NonNullable<Awaited<ReturnType<typeof listProducts>>>;
+export type ListProductsQueryError = ListProducts501;
+export declare function useListProducts<TData = Awaited<ReturnType<typeof listProducts>>, TError = ListProducts501>(options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listProducts>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listProducts>>, TError, Awaited<ReturnType<typeof listProducts>>>, 'initialData'>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListProducts<TData = Awaited<ReturnType<typeof listProducts>>, TError = ListProducts501>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listProducts>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listProducts>>, TError, Awaited<ReturnType<typeof listProducts>>>, 'initialData'>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListProducts<TData = Awaited<ReturnType<typeof listProducts>>, TError = ListProducts501>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listProducts>>, TError, TData>>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * @summary List supported couriers and their services
+ */
+export type listCouriersResponse200 = {
+    data: ListCouriers200Item[];
+    status: 200;
+};
+export type listCouriersResponseSuccess = (listCouriersResponse200) & {
+    headers: Headers;
+};
+export type listCouriersResponse = (listCouriersResponseSuccess);
+export declare const getListCouriersUrl: () => string;
+export declare const listCouriers: (options?: RequestInit) => Promise<listCouriersResponse>;
+export declare const getListCouriersQueryKey: () => readonly ["/api/v1/couriers"];
+export declare const getListCouriersQueryOptions: <TData = Awaited<ReturnType<typeof listCouriers>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listCouriers>>, TError, TData>>;
+    fetch?: RequestInit;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listCouriers>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListCouriersQueryResult = NonNullable<Awaited<ReturnType<typeof listCouriers>>>;
+export type ListCouriersQueryError = unknown;
+export declare function useListCouriers<TData = Awaited<ReturnType<typeof listCouriers>>, TError = unknown>(options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listCouriers>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listCouriers>>, TError, Awaited<ReturnType<typeof listCouriers>>>, 'initialData'>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListCouriers<TData = Awaited<ReturnType<typeof listCouriers>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listCouriers>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listCouriers>>, TError, Awaited<ReturnType<typeof listCouriers>>>, 'initialData'>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListCouriers<TData = Awaited<ReturnType<typeof listCouriers>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listCouriers>>, TError, TData>>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * @summary List supported bank codes and names
+ */
+export type listBankCodesResponse200 = {
+    data: ListBankCodes200Item[];
+    status: 200;
+};
+export type listBankCodesResponseSuccess = (listBankCodesResponse200) & {
+    headers: Headers;
+};
+export type listBankCodesResponse = (listBankCodesResponseSuccess);
+export declare const getListBankCodesUrl: () => string;
+export declare const listBankCodes: (options?: RequestInit) => Promise<listBankCodesResponse>;
+export declare const getListBankCodesQueryKey: () => readonly ["/api/v1/banks"];
+export declare const getListBankCodesQueryOptions: <TData = Awaited<ReturnType<typeof listBankCodes>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listBankCodes>>, TError, TData>>;
+    fetch?: RequestInit;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listBankCodes>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListBankCodesQueryResult = NonNullable<Awaited<ReturnType<typeof listBankCodes>>>;
+export type ListBankCodesQueryError = unknown;
+export declare function useListBankCodes<TData = Awaited<ReturnType<typeof listBankCodes>>, TError = unknown>(options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listBankCodes>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listBankCodes>>, TError, Awaited<ReturnType<typeof listBankCodes>>>, 'initialData'>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListBankCodes<TData = Awaited<ReturnType<typeof listBankCodes>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listBankCodes>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listBankCodes>>, TError, Awaited<ReturnType<typeof listBankCodes>>>, 'initialData'>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListBankCodes<TData = Awaited<ReturnType<typeof listBankCodes>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listBankCodes>>, TError, TData>>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * @summary List supported payment channel codes
+ */
+export type listPaymentChannelsResponse200 = {
+    data: string[];
+    status: 200;
+};
+export type listPaymentChannelsResponseSuccess = (listPaymentChannelsResponse200) & {
+    headers: Headers;
+};
+export type listPaymentChannelsResponse = (listPaymentChannelsResponseSuccess);
+export declare const getListPaymentChannelsUrl: () => string;
+export declare const listPaymentChannels: (options?: RequestInit) => Promise<listPaymentChannelsResponse>;
+export declare const getListPaymentChannelsQueryKey: () => readonly ["/api/v1/payment-channels"];
+export declare const getListPaymentChannelsQueryOptions: <TData = Awaited<ReturnType<typeof listPaymentChannels>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listPaymentChannels>>, TError, TData>>;
+    fetch?: RequestInit;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listPaymentChannels>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListPaymentChannelsQueryResult = NonNullable<Awaited<ReturnType<typeof listPaymentChannels>>>;
+export type ListPaymentChannelsQueryError = unknown;
+export declare function useListPaymentChannels<TData = Awaited<ReturnType<typeof listPaymentChannels>>, TError = unknown>(options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listPaymentChannels>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listPaymentChannels>>, TError, Awaited<ReturnType<typeof listPaymentChannels>>>, 'initialData'>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListPaymentChannels<TData = Awaited<ReturnType<typeof listPaymentChannels>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listPaymentChannels>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listPaymentChannels>>, TError, Awaited<ReturnType<typeof listPaymentChannels>>>, 'initialData'>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListPaymentChannels<TData = Awaited<ReturnType<typeof listPaymentChannels>>, TError = unknown>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listPaymentChannels>>, TError, TData>>;
+    fetch?: RequestInit;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
 /**
  * @summary Health check
  */