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

TypeScript client library for Augur microservices API endpoints

import type { P21PimClient } from '../client';
import type { AISuggestionParams, SuggestDisplayDescResponse, SuggestWebDescResponse } from '../schemas';
type ExecuteRequest = P21PimClient['executeRequest'];
/**
 * Creates the items resource methods
 * OpenAPI Path: /items → items.*
 * @description Generate AI-powered product descriptions using advanced language models
 */
export declare function createItemsResource(executeRequest: ExecuteRequest): {
    /**
     * Suggest Display Description operations
     *
     * @fullPath api.p21Pim.items.suggestDisplayDesc
     */
    suggestDisplayDesc: {
        /**
         * Generate marketing-focused display descriptions (255 character limit)
         *
         * @fullPath api.p21Pim.items.suggestDisplayDesc.get
         * @service p21-pim
         * @domain ai-content-generation
         * @dataMethod itemsData.suggestDisplayDesc.get
         * @discoverable true
         * @searchTerms ['ai', 'display', 'descriptions', 'marketing', 'suggestions']
         * @relatedEndpoints ['items.suggestWebDesc']
         * @commonPatterns ['Generate marketing descriptions', 'AI display content']
         *
         * @param invMastUid Inventory master UID (must match OpenAPI parameter name)
         * @param params Optional parameters including limit and model selection
         * @returns Array of display description suggestions
         */
        get: (invMastUid: number, params?: AISuggestionParams) => Promise<SuggestDisplayDescResponse>;
    };
    /**
     * Suggest Web Description operations
     *
     * @fullPath api.p21Pim.items.suggestWebDesc
     */
    suggestWebDesc: {
        /**
         * Generate detailed web descriptions (4000 character limit)
         *
         * @fullPath api.p21Pim.items.suggestWebDesc.get
         * @service p21-pim
         * @domain ai-content-generation
         * @dataMethod itemsData.suggestWebDesc.get
         * @discoverable true
         * @searchTerms ['ai', 'web', 'descriptions', 'detailed', 'suggestions']
         * @relatedEndpoints ['items.suggestDisplayDesc']
         * @commonPatterns ['Generate web descriptions', 'AI detailed content']
         *
         * @param invMastUid Inventory master UID (must match OpenAPI parameter name)
         * @param params Optional parameters including limit and model selection
         * @returns Array of web description suggestions
         */
        get: (invMastUid: number, params?: AISuggestionParams) => Promise<SuggestWebDescResponse>;
    };
};
/**
 * Creates the itemsData resource methods (data-only versions)
 */
export declare function createItemsDataResource(items: ReturnType<typeof createItemsResource>): {
    suggestDisplayDesc: {
        get: (invMastUid: number, params?: AISuggestionParams) => Promise<false | import("zod").objectOutputType<{}, import("zod").ZodTypeAny, "passthrough">[]>;
    };
    suggestWebDesc: {
        get: (invMastUid: number, params?: AISuggestionParams) => Promise<false | import("zod").objectOutputType<{}, import("zod").ZodTypeAny, "passthrough">[]>;
    };
};
export type ItemsResource = ReturnType<typeof createItemsResource>;
export type ItemsDataResource = ReturnType<typeof createItemsDataResource>;
export {};
//# sourceMappingURL=items.d.ts.map