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

TypeScript client library for Augur microservices API endpoints

import { CreateBrandRequest, UpdateBrandRequest, BrandListParams, CreateBrandItemRequest, UpdateBrandItemRequest } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the brands resource methods
 * OpenAPI Path: /brands → brands.*
 * @description Methods for managing product brands
 */
export declare function createBrandsResource(executeRequest: ExecuteRequest): {
    /**
     * List all brands
     * @description Retrieve a paginated list of brands with filtering options
     * @fullPath api.items.brands.list
     * @service items
     * @domain inventory-management
     * @discoverable true
     * @dataMethod brandsData.list
     */
    list: (params?: BrandListParams) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: import("zod").objectInputType<{
            brandsUid: import("zod").ZodNumber;
        }, import("zod").ZodTypeAny, "passthrough">[];
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Create new brand
     * @description Create a new brand
     * @fullPath api.items.brands.create
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    create: (data: CreateBrandRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            brandsUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Get brand by ID
     * @description Retrieve specific brand details
     * @fullPath api.items.brands.get
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    get: (brandsUid: number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            brandsUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Update brand
     * @description Update existing brand
     * @fullPath api.items.brands.update
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    update: (brandsUid: number, data: UpdateBrandRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            brandsUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Delete brand
     * @description Delete existing brand
     * @fullPath api.items.brands.delete
     * @service items
     * @domain inventory-management
     * @discoverable true
     */
    delete: (brandsUid: number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            brandsUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * OpenAPI Path: /brands/{brandsUid}/items → brands.items.*
     * @description Nested path for managing items within brands
     */
    items: {
        /**
         * List brand items
         * @description List all items associated with a brand
         * @fullPath api.items.brands.items.list
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        list: (brandsUid: number, params?: Record<string, unknown>) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: import("zod").objectInputType<{
                brandItemUid: import("zod").ZodNumber;
            }, import("zod").ZodTypeAny, "passthrough">[];
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Add item to brand
         * @description Create association between item and brand
         * @fullPath api.items.brands.items.create
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        create: (brandsUid: number, data: CreateBrandItemRequest) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                brandItemUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Get brand item association
         * @description Get specific brand-item association details
         * @fullPath api.items.brands.items.get
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        get: (brandsUid: number, brandsXItemsUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                brandItemUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Update brand item association
         * @description Update existing brand-item association
         * @fullPath api.items.brands.items.update
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        update: (brandsUid: number, brandsXItemsUid: number, data: UpdateBrandItemRequest) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                brandItemUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Remove item from brand
         * @description Delete brand-item association
         * @fullPath api.items.brands.items.delete
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        delete: (brandsUid: number, brandsXItemsUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                brandItemUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
    };
};
/**
 * Creates the brandsData resource methods (data-only versions)
 */
export declare function createBrandsDataResource(brands: ReturnType<typeof createBrandsResource>): {
    list: (params?: BrandListParams) => Promise<import("zod").objectInputType<{
        brandsUid: import("zod").ZodNumber;
    }, import("zod").ZodTypeAny, "passthrough">[]>;
    create: (data: CreateBrandRequest) => Promise<{
        brandsUid: number;
    } & {
        [k: string]: unknown;
    }>;
    get: (brandsUid: number) => Promise<{
        brandsUid: number;
    } & {
        [k: string]: unknown;
    }>;
    update: (brandsUid: number, data: UpdateBrandRequest) => Promise<{
        brandsUid: number;
    } & {
        [k: string]: unknown;
    }>;
    delete: (brandsUid: number) => Promise<{
        brandsUid: number;
    } & {
        [k: string]: unknown;
    }>;
    items: {
        list: (brandsUid: number, params?: Record<string, unknown>) => Promise<import("zod").objectInputType<{
            brandItemUid: import("zod").ZodNumber;
        }, import("zod").ZodTypeAny, "passthrough">[]>;
        create: (brandsUid: number, data: CreateBrandItemRequest) => Promise<{
            brandItemUid: number;
        } & {
            [k: string]: unknown;
        }>;
        get: (brandsUid: number, brandsXItemsUid: number) => Promise<{
            brandItemUid: number;
        } & {
            [k: string]: unknown;
        }>;
        update: (brandsUid: number, brandsXItemsUid: number, data: UpdateBrandItemRequest) => Promise<{
            brandItemUid: number;
        } & {
            [k: string]: unknown;
        }>;
        delete: (brandsUid: number, brandsXItemsUid: number) => Promise<{
            brandItemUid: number;
        } & {
            [k: string]: unknown;
        }>;
    };
};
export type BrandsResource = ReturnType<typeof createBrandsResource>;
export type BrandsDataResource = ReturnType<typeof createBrandsDataResource>;
export {};
//# sourceMappingURL=brands.d.ts.map