@simpleapps-com/augur-api/dist/cjs/services/items/resources/variants.d.ts

TypeScript client library for Augur microservices API endpoints

import { CreateItemVariantHeaderRequest, UpdateItemVariantHeaderRequest, CreateItemVariantLineRequest, UpdateItemVariantLineRequest, ItemVariantListParams } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the variants resource methods
 * OpenAPI Path: /variants → variants.*
 * @description Methods for managing product variants
 */
export declare function createVariantsResource(executeRequest: ExecuteRequest): {
    /**
     * List product variants
     * @description Retrieve a list of product variants
     * @fullPath api.items.variants.list
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    list: (params?: ItemVariantListParams) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: import("zod").objectInputType<{
            itemVariantHdrUid: import("zod").ZodNumber;
        }, import("zod").ZodTypeAny, "passthrough">[];
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Create product variant
     * @description Create new product variant
     * @fullPath api.items.variants.create
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    create: (data: CreateItemVariantHeaderRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            itemVariantHdrUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Get product variant
     * @description Get specific product variant details
     * @fullPath api.items.variants.get
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    get: (itemVariantHdrUid: number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            itemVariantHdrUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Update product variant
     * @description Update existing product variant
     * @fullPath api.items.variants.update
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    update: (itemVariantHdrUid: number, data: UpdateItemVariantHeaderRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            itemVariantHdrUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Delete product variant
     * @description Delete existing product variant
     * @fullPath api.items.variants.delete
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    delete: (itemVariantHdrUid: number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            itemVariantHdrUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * OpenAPI Path: /variants/{itemVariantHdrUid}/lines → variants.lines.*
     * @description Nested path for variant lines
     */
    lines: {
        /**
         * List variant lines
         * @description Get all lines for a variant
         * @fullPath api.items.variants.lines.list
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        list: (itemVariantHdrUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: import("zod").objectInputType<{
                itemVariantLineUid: import("zod").ZodNumber;
            }, import("zod").ZodTypeAny, "passthrough">[];
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Create variant line
         * @description Add a new line to a variant
         * @fullPath api.items.variants.lines.create
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        create: (itemVariantHdrUid: number, data: CreateItemVariantLineRequest) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                itemVariantLineUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Get variant line
         * @description Get specific variant line details
         * @fullPath api.items.variants.lines.get
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        get: (itemVariantHdrUid: number, itemVariantLineUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                itemVariantLineUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Update variant line
         * @description Update existing variant line
         * @fullPath api.items.variants.lines.update
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        update: (itemVariantHdrUid: number, itemVariantLineUid: number, data: UpdateItemVariantLineRequest) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                itemVariantLineUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Delete variant line
         * @description Remove a line from a variant
         * @fullPath api.items.variants.lines.delete
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        delete: (itemVariantHdrUid: number, itemVariantLineUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                itemVariantLineUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
    };
};
/**
 * Creates the variantsData resource methods (data-only versions)
 */
export declare function createVariantsDataResource(variants: ReturnType<typeof createVariantsResource>): {
    list: (params?: ItemVariantListParams) => Promise<import("zod").objectInputType<{
        itemVariantHdrUid: import("zod").ZodNumber;
    }, import("zod").ZodTypeAny, "passthrough">[]>;
    create: (data: CreateItemVariantHeaderRequest) => Promise<{
        itemVariantHdrUid: number;
    } & {
        [k: string]: unknown;
    }>;
    get: (itemVariantHdrUid: number) => Promise<{
        itemVariantHdrUid: number;
    } & {
        [k: string]: unknown;
    }>;
    update: (itemVariantHdrUid: number, data: UpdateItemVariantHeaderRequest) => Promise<{
        itemVariantHdrUid: number;
    } & {
        [k: string]: unknown;
    }>;
    delete: (itemVariantHdrUid: number) => Promise<{
        itemVariantHdrUid: number;
    } & {
        [k: string]: unknown;
    }>;
    lines: {
        list: (itemVariantHdrUid: number) => Promise<import("zod").objectInputType<{
            itemVariantLineUid: import("zod").ZodNumber;
        }, import("zod").ZodTypeAny, "passthrough">[]>;
        create: (itemVariantHdrUid: number, data: CreateItemVariantLineRequest) => Promise<{
            itemVariantLineUid: number;
        } & {
            [k: string]: unknown;
        }>;
        get: (itemVariantHdrUid: number, itemVariantLineUid: number) => Promise<{
            itemVariantLineUid: number;
        } & {
            [k: string]: unknown;
        }>;
        update: (itemVariantHdrUid: number, itemVariantLineUid: number, data: UpdateItemVariantLineRequest) => Promise<{
            itemVariantLineUid: number;
        } & {
            [k: string]: unknown;
        }>;
        delete: (itemVariantHdrUid: number, itemVariantLineUid: number) => Promise<{
            itemVariantLineUid: number;
        } & {
            [k: string]: unknown;
        }>;
    };
};
export type VariantsResource = ReturnType<typeof createVariantsResource>;
export type VariantsDataResource = ReturnType<typeof createVariantsDataResource>;
export {};
//# sourceMappingURL=variants.d.ts.map