@simpleapps-com/augur-api/dist/esm/services/brand-folder/client.d.ts

TypeScript client library for Augur microservices API endpoints

import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type CategoriesResource, type CategoriesDataResource } from './resources';
/**
 * Brand Folder Service Client
 * @description Client for interacting with Brand Folder API endpoints for category focus management and brand organization
 * @fullPath api.brandFolder
 * @service brand-folder
 * @domain brand-management
 * @discoverable true
 * @searchTerms ["brand-folder", "category focus", "brand management", "category organization", "brand configuration", "focus management"]
 * @relatedEndpoints ["api.brandFolder.healthCheck.get", "api.brandFolder.categories.focus.create", "api.items.categories.list", "api.commerce.brands.list"]
 * @commonPatterns ["Brand management", "Category focus configuration", "Brand organization", "Category prioritization"]
 * @workflow ["brand-management", "category-organization", "content-management", "merchandising"]
 * @functionalArea "brand-and-category-management"
 * @businessRules ["Requires valid bearer authentication", "Category focus configuration", "Brand-category associations", "Priority-based organization"]
 * @performance "Optimized for brand management workflows and category focus operations"
 * @example
 * ```typescript
 * import { HTTPClient } from '@augur/api-client/core';
 * import { BrandFolderClient } from '@augur/api-client/services/brand-folder';
 *
 * const http = new HTTPClient('brand-folder', { siteId: 'your-site-id', bearerToken: 'your-token' });
 * const brandFolder = new BrandFolderClient(http);
 *
 * // Check service health
 * const health = await brandFolder.healthCheck.get();
 * const healthData = await brandFolder.healthCheckData.get();
 *
 * // Set category focus
 * const focusConfig = {
 *   categoryId: 'cat-123',
 *   focusLevel: 'primary' as const,
 *   priority: 95,
 *   isActive: true
 * };
 * const focus = await brandFolder.categories.focus.create(focusConfig);
 * const focusData = await brandFolder.categoriesData.focus.create(focusConfig);
 * ```
 */
export declare class BrandFolderClient extends BaseServiceClient {
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Categories resource */
    readonly categories: CategoriesResource;
    /** Categories data resource (data-only) */
    readonly categoriesData: CategoriesDataResource;
    constructor(http: HTTPClient, baseUrl?: string);
    protected getServiceDescription(): string;
}
//# sourceMappingURL=client.d.ts.map