@simpleapps-com/augur-api/dist/esm/services/items/resources/attribute-groups.d.ts

TypeScript client library for Augur microservices API endpoints

import { CreateAttributeGroupRequest, UpdateAttributeGroupRequest, AttributeGroupListParams, CreateAttributeGroupAttributeRequest, UpdateAttributeGroupAttributeRequest } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the attributeGroups resource methods
 * OpenAPI Path: /attribute-groups → attributeGroups.*
 * @description Methods for managing attribute groups with CRUD operations
 */
export declare function createAttributeGroupsResource(executeRequest: ExecuteRequest): {
    /**
     * List all attribute groups
     * @description Retrieve a list of attribute groups with filtering options
     * @fullPath api.items.attributeGroups.list
     * @service items
     * @domain inventory-management
     * @discoverable true
     * @dataMethod attributeGroupsData.list
     */
    list: (params?: AttributeGroupListParams) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: import("zod").objectInputType<{
            attributeGroupUid: import("zod").ZodNumber;
        }, import("zod").ZodTypeAny, "passthrough">[];
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Create new attribute group
     * @description Create a new attribute group
     * @fullPath api.items.attributeGroups.create
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    create: (data: CreateAttributeGroupRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            attributeGroupUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Get attribute group by ID
     * @description Retrieve specific attribute group details
     * @fullPath api.items.attributeGroups.get
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    get: (attributeGroupUid: number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            attributeGroupUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Update attribute group
     * @description Update existing attribute group
     * @fullPath api.items.attributeGroups.update
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    update: (attributeGroupUid: number, data: UpdateAttributeGroupRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            attributeGroupUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Delete attribute group
     * @description Delete existing attribute group
     * @fullPath api.items.attributeGroups.delete
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    delete: (attributeGroupUid: number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            attributeGroupUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * OpenAPI Path: /attribute-groups/{attributeGroupUid}/attributes → attributeGroups.attributes.*
     * @description Nested path for managing attributes within attribute groups
     */
    attributes: {
        /**
         * List attributes in attribute group
         * @description List all attributes associated with an attribute group
         * @fullPath api.items.attributeGroups.attributes.list
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        list: (attributeGroupUid: number, params?: Record<string, unknown>) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: import("zod").objectInputType<{
                attributeXAttributeGroupUid: import("zod").ZodNumber;
            }, import("zod").ZodTypeAny, "passthrough">[];
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Add attribute to attribute group
         * @description Create association between attribute and attribute group
         * @fullPath api.items.attributeGroups.attributes.create
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        create: (attributeGroupUid: number, data: CreateAttributeGroupAttributeRequest) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                attributeXAttributeGroupUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Get attribute group attribute association
         * @description Get specific attribute-group association details
         * @fullPath api.items.attributeGroups.attributes.get
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        get: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                attributeXAttributeGroupUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Update attribute group attribute association
         * @description Update existing attribute-group association
         * @fullPath api.items.attributeGroups.attributes.update
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        update: (attributeGroupUid: number, attributeXAttributeGroupUid: number, data: UpdateAttributeGroupAttributeRequest) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                attributeXAttributeGroupUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Remove attribute from attribute group
         * @description Delete attribute-group association
         * @fullPath api.items.attributeGroups.attributes.delete
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        delete: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                attributeXAttributeGroupUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
    };
};
/**
 * Creates the attributeGroupsData resource methods (data-only versions)
 */
export declare function createAttributeGroupsDataResource(attributeGroups: ReturnType<typeof createAttributeGroupsResource>): {
    list: (params?: AttributeGroupListParams) => Promise<import("zod").objectInputType<{
        attributeGroupUid: import("zod").ZodNumber;
    }, import("zod").ZodTypeAny, "passthrough">[]>;
    create: (data: CreateAttributeGroupRequest) => Promise<{
        attributeGroupUid: number;
    } & {
        [k: string]: unknown;
    }>;
    get: (attributeGroupUid: number) => Promise<{
        attributeGroupUid: number;
    } & {
        [k: string]: unknown;
    }>;
    update: (attributeGroupUid: number, data: UpdateAttributeGroupRequest) => Promise<{
        attributeGroupUid: number;
    } & {
        [k: string]: unknown;
    }>;
    delete: (attributeGroupUid: number) => Promise<{
        attributeGroupUid: number;
    } & {
        [k: string]: unknown;
    }>;
    attributes: {
        list: (attributeGroupUid: number, params?: Record<string, unknown>) => Promise<import("zod").objectInputType<{
            attributeXAttributeGroupUid: import("zod").ZodNumber;
        }, import("zod").ZodTypeAny, "passthrough">[]>;
        create: (attributeGroupUid: number, data: CreateAttributeGroupAttributeRequest) => Promise<{
            attributeXAttributeGroupUid: number;
        } & {
            [k: string]: unknown;
        }>;
        get: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
            attributeXAttributeGroupUid: number;
        } & {
            [k: string]: unknown;
        }>;
        update: (attributeGroupUid: number, attributeXAttributeGroupUid: number, data: UpdateAttributeGroupAttributeRequest) => Promise<{
            attributeXAttributeGroupUid: number;
        } & {
            [k: string]: unknown;
        }>;
        delete: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
            attributeXAttributeGroupUid: number;
        } & {
            [k: string]: unknown;
        }>;
    };
};
export type AttributeGroupsResource = ReturnType<typeof createAttributeGroupsResource>;
export type AttributeGroupsDataResource = ReturnType<typeof createAttributeGroupsDataResource>;
export {};
//# sourceMappingURL=attribute-groups.d.ts.map