@simpleapps-com/augur-api 0.3.3 → 0.4.1

package/dist/cjs/services/brand-folder/client.js

@@ -5,141 +5,198 @@ const base_client_1 = require("../../core/base-client");
 const schemas_1 = require("./schemas");
 /**
  * Brand Folder Service Client
- *
- * Provides access to brand folder management endpoints for category focus
- * management and brand organization capabilities.
- *
+ * @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.healthCheck.getData();
+ *
+ * // 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.categories.focus.getData(focusConfig);
+ * ```
  */
 class BrandFolderClient extends base_client_1.BaseServiceClient {
     constructor(http, baseUrl) {
         super('brand-folder', http, baseUrl || 'https://brand-folder.augur-api.com');
         /**
-         * Check service health and availability
-         *
-         * @fullPath api.brandFolder.healthCheck.get
-         * @service brand-folder
-         * @domain system-health
-         * @dataMethod healthCheckData
-         * @discoverable true
-         * @searchTerms ["health", "status", "availability", "ping", "check", "brand service"]
-         * @relatedEndpoints ["api.brandFolder.categories.focus.set", "api.avalara.healthCheck.get", "api.agrWork.healthCheck.get", "api.agrInfo.healthCheck.get"]
-         * @commonPatterns ["Health check", "Service status", "Brand service availability", "System monitoring"]
-         * @workflow ["system-monitoring", "health-checks", "service-discovery", "brand-service-verification"]
-         * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
-         * @nextSteps ["Use brand management endpoints if healthy", "Verify brand service connectivity", "Monitor service metrics"]
-         * @businessRules ["Returns service status and basic info", "Requires standard authentication", "Standard health check format"]
-         * @functionalArea "system-monitoring"
-         * @caching "No caching - real-time status required"
-         * @performance "Fast response, minimal processing, use for brand service monitoring"
-         *
-         * @returns Promise<HealthCheckResponse> Service health status
-         *
-         * @example
-         * ```typescript
-         * // Check if brand service is healthy
-         * const response = await client.healthCheck();
-         * console.log(response.data); // Health status string
-         * console.log(response.status); // HTTP status code
-         *
-         * // Get just the health status
-         * const status = await client.healthCheckData();
-         * console.log(status); // Direct string access
-         * ```
-         */
-        this.healthCheck = this.createHealthCheckMethod(schemas_1.HealthCheckResponseSchema);
-        /**
-         * Set category focus configuration for brand management
-         *
-         * @fullPath api.brandFolder.categories.focus.set
-         * @service brand-folder
-         * @domain brand-management
-         * @dataMethod categoriesFocusSetData
-         * @discoverable true
-         * @searchTerms ["category", "focus", "brand", "priority", "configuration", "management", "organization"]
-         * @relatedEndpoints ["api.items.categories.list", "api.commerce.brands.list", "api.customers.preferences.set", "api.items.catalog.organize"]
-         * @commonPatterns ["Set category focus", "Configure brand priorities", "Organize brand categories", "Manage category visibility", "Brand taxonomy management"]
-         * @workflow ["brand-management", "category-organization", "content-management", "merchandising", "brand-strategy"]
-         * @prerequisites ["Valid brand/category data", "Public bearer token", "x-site-id header", "Category or brand identification"]
-         * @nextSteps ["Verify focus configuration", "Update brand displays", "Refresh category hierarchies", "Monitor brand performance"]
-         * @businessRules ["Supports primary/secondary/tertiary focus levels", "Allows priority ranking 1-100", "Configurable visibility settings", "Brand-category associations", "Effective date management"]
-         * @functionalArea "brand-and-category-management"
-         * @crossSite "Multi-site brand focus configuration support"
-         * @caching "Cache for 30 minutes, brand focus changes infrequently"
-         * @performance "Optimize by batching multiple category updates, validate before submission"
-         *
-         * @param params Category focus configuration parameters including focus level, priority, and brand associations
-         * @returns Promise<CategoryFocusResponse> Complete category focus configuration results with applied settings
-         *
-         * @example
-         * ```typescript
-         * // Set primary focus for a category
-         * const focusConfig = {
-         *   categoryId: 'cat-123',
-         *   focusLevel: 'primary' as const,
-         *   priority: 95,
-         *   isActive: true,
-         *   brandId: 'brand-456',
-         *   visibility: 'public' as const,
-         *   featured: true
-         * };
-         *
-         * const response = await client.categoriesFocusSet(focusConfig);
-         * console.log(response.data.focusLevel); // Applied focus level
-         * console.log(response.data.priority); // Set priority value
-         *
-         * // Get just the focus result
-         * const focusResult = await client.categoriesFocusSetData(focusConfig);
-         * console.log(focusResult.categoryId); // Direct access to category ID
-         *
-         * // Configure category with brand association
-         * const brandFocusConfig = {
-         *   categoryName: 'Electronics',
-         *   categorySlug: 'electronics',
-         *   focusLevel: 'secondary' as const,
-         *   priority: 75,
-         *   brandName: 'TechBrand',
-         *   description: 'Featured electronics category',
-         *   tags: ['electronics', 'featured', 'tech'],
-         *   displayOrder: 2,
-         *   visibility: 'public' as const
-         * };
-         *
-         * const brandResult = await client.categoriesFocusSetData(brandFocusConfig);
-         *
-         * // Batch category focus updates
-         * const categories = [
-         *   { categoryId: 'cat-1', focusLevel: 'primary' as const, priority: 100 },
-         *   { categoryId: 'cat-2', focusLevel: 'secondary' as const, priority: 80 },
-         *   { categoryId: 'cat-3', focusLevel: 'tertiary' as const, priority: 60 }
-         * ];
-         *
-         * // Process multiple categories
-         * for (const category of categories) {
-         *   const result = await client.categoriesFocusSetData(category);
-         *   console.log(`Set ${category.categoryId} to ${result.focusLevel}`);
-         * }
-         * ```
-         */
-        this.categoriesFocusSet = this.createCreateMethod('/categories/focus', schemas_1.CategoryFocusRequestParamsSchema, schemas_1.CategoryFocusResponseSchema);
-        // Data-only methods for direct access to response data
-        /**
-         * Get health check status data only
-         * @returns Promise<string> Health status string
+         * Health Check Operations
+         * @description System health monitoring and availability verification for Brand Folder service
          */
-        this.healthCheckData = async () => {
-            const response = await this.healthCheck();
-            return response.data;
+        this.healthCheck = {
+            /**
+             * Check service health and availability
+             *
+             * @fullPath api.brandFolder.healthCheck.get
+             * @service brand-folder
+             * @domain system-health
+             * @dataMethod healthCheck.getData - returns only the health status data without metadata
+             * @discoverable true
+             * @searchTerms ["health", "status", "availability", "ping", "check", "brand service", "monitoring"]
+             * @relatedEndpoints ["api.brandFolder.categories.focus.create", "api.avalara.healthCheck.get", "api.agrWork.healthCheck.get", "api.agrInfo.healthCheck.get", "api.items.healthCheck.get"]
+             * @commonPatterns ["Health check", "Service status", "Brand service availability", "System monitoring"]
+             * @workflow ["system-monitoring", "health-checks", "service-discovery", "brand-service-verification"]
+             * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
+             * @nextSteps ["Use brand management endpoints if healthy", "Verify brand service connectivity", "Monitor service metrics"]
+             * @businessRules ["Returns service status and basic info", "Requires standard authentication", "Standard health check format"]
+             * @functionalArea "system-monitoring"
+             * @caching "No caching - real-time status required"
+             * @performance "Fast response, minimal processing, use for brand service monitoring"
+             *
+             * @returns Promise<HealthCheckResponse> Service health status
+             *
+             * @example
+             * ```typescript
+             * // Check if brand service is healthy
+             * const response = await client.healthCheck.get();
+             * console.log(response.data); // Health status string
+             * console.log(response.status); // HTTP status code
+             *
+             * // Get just the health status
+             * const status = await client.healthCheck.getData();
+             * console.log(status); // Direct string access
+             * ```
+             */
+            get: async () => {
+                return this.executeRequest({
+                    method: 'GET',
+                    path: '/health-check',
+                    responseSchema: schemas_1.HealthCheckResponseSchema,
+                }, undefined);
+            },
+            /**
+             * Get health check status data only
+             * @returns Promise<string> Health status string
+             */
+            getData: async () => {
+                const response = await this.healthCheck.get();
+                return response.data;
+            },
         };
         /**
-         * Set category focus configuration and return result data only
-         * @param params Category focus configuration parameters
-         * @returns Promise<CategoryFocusResult> Category focus configuration result with applied settings
+         * Categories Operations
+         * @description Category management and organization functionality
          */
-        this.categoriesFocusSetData = async (params) => {
-            const response = await this.categoriesFocusSet(params);
-            return response.data;
+        this.categories = {
+            /**
+             * Focus Operations
+             * @description Category focus configuration and priority management
+             */
+            focus: {
+                /**
+                 * Set category focus configuration for brand management
+                 *
+                 * @fullPath api.brandFolder.categories.focus.create
+                 * @service brand-folder
+                 * @domain brand-management
+                 * @dataMethod categories.focus.getData - returns only the focus configuration data without metadata
+                 * @discoverable true
+                 * @searchTerms ["category", "focus", "brand", "priority", "configuration", "management", "organization", "create"]
+                 * @relatedEndpoints ["api.items.categories.list", "api.commerce.brands.list", "api.customers.preferences.set", "api.items.catalog.organize"]
+                 * @commonPatterns ["Set category focus", "Configure brand priorities", "Organize brand categories", "Manage category visibility", "Brand taxonomy management"]
+                 * @workflow ["brand-management", "category-organization", "content-management", "merchandising", "brand-strategy"]
+                 * @prerequisites ["Valid brand/category data", "Public bearer token", "x-site-id header", "Category or brand identification"]
+                 * @nextSteps ["Verify focus configuration", "Update brand displays", "Refresh category hierarchies", "Monitor brand performance"]
+                 * @businessRules ["Supports primary/secondary/tertiary focus levels", "Allows priority ranking 1-100", "Configurable visibility settings", "Brand-category associations", "Effective date management"]
+                 * @functionalArea "brand-and-category-management"
+                 * @crossSite "Multi-site brand focus configuration support"
+                 * @caching "Cache for 30 minutes, brand focus changes infrequently"
+                 * @performance "Optimize by batching multiple category updates, validate before submission"
+                 *
+                 * @param params Category focus configuration parameters including focus level, priority, and brand associations
+                 * @returns Promise<CategoryFocusResponse> Complete category focus configuration results with applied settings
+                 *
+                 * @example
+                 * ```typescript
+                 * // Set primary focus for a category
+                 * const focusConfig = {
+                 *   categoryId: 'cat-123',
+                 *   focusLevel: 'primary' as const,
+                 *   priority: 95,
+                 *   isActive: true,
+                 *   brandId: 'brand-456',
+                 *   visibility: 'public' as const,
+                 *   featured: true
+                 * };
+                 *
+                 * const response = await client.categories.focus.create(focusConfig);
+                 * console.log(response.data.focusLevel); // Applied focus level
+                 * console.log(response.data.priority); // Set priority value
+                 *
+                 * // Get just the focus result
+                 * const focusResult = await client.categories.focus.getData(focusConfig);
+                 * console.log(focusResult.categoryId); // Direct access to category ID
+                 *
+                 * // Configure category with brand association
+                 * const brandFocusConfig = {
+                 *   categoryName: 'Electronics',
+                 *   categorySlug: 'electronics',
+                 *   focusLevel: 'secondary' as const,
+                 *   priority: 75,
+                 *   brandName: 'TechBrand',
+                 *   description: 'Featured electronics category',
+                 *   tags: ['electronics', 'featured', 'tech'],
+                 *   displayOrder: 2,
+                 *   visibility: 'public' as const
+                 * };
+                 *
+                 * const brandResult = await client.categories.focus.getData(brandFocusConfig);
+                 *
+                 * // Batch category focus updates
+                 * const categories = [
+                 *   { categoryId: 'cat-1', focusLevel: 'primary' as const, priority: 100 },
+                 *   { categoryId: 'cat-2', focusLevel: 'secondary' as const, priority: 80 },
+                 *   { categoryId: 'cat-3', focusLevel: 'tertiary' as const, priority: 60 }
+                 * ];
+                 *
+                 * // Process multiple categories
+                 * for (const category of categories) {
+                 *   const result = await client.categories.focus.getData(category);
+                 *   console.log(`Set ${category.categoryId} to ${result.focusLevel}`);
+                 * }
+                 * ```
+                 */
+                create: async (params) => {
+                    return this.executeRequest({
+                        method: 'POST',
+                        path: '/categories/focus',
+                        responseSchema: schemas_1.CategoryFocusResponseSchema,
+                    }, params);
+                },
+                /**
+                 * Set category focus configuration and return result data only
+                 * @param params Category focus configuration parameters
+                 * @returns Promise<CategoryFocusResult> Category focus configuration result with applied settings
+                 */
+                getData: async (params) => {
+                    const response = await this.categories.focus.create(params);
+                    return response.data;
+                },
+            },
         };
     }
     getServiceDescription() {

package/dist/cjs/services/brand-folder/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/brand-folder/client.ts"],"names":[],"mappings":";;;AAAA,wDAA2D;AAE3D,uCAMmB;AAEnB;;;;;;;;GAQG;AACH,MAAa,iBAAkB,SAAQ,+BAAiB;IACtD,YAAY,IAAgB,EAAE,OAAgB;QAC5C,KAAK,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,IAAI,oCAAoC,CAAC,CAAC;QAO/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;QACM,gBAAW,GAAG,IAAI,CAAC,uBAAuB,CAAC,mCAAyB,CAAC,CAAC;QAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwEG;QACM,uBAAkB,GAAG,IAAI,CAAC,kBAAkB,CACnD,mBAAmB,EACnB,0CAAgC,EAChC,qCAA2B,CAC5B,CAAC;QAEF,uDAAuD;QAEvD;;;WAGG;QACM,oBAAe,GAAG,KAAK,IAAqB,EAAE;YACrD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;QAEF;;;;WAIG;QACM,2BAAsB,GAAG,KAAK,EACrC,MAAkC,EACJ,EAAE;YAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YACvD,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;IA7IF,CAAC;IAES,qBAAqB;QAC7B,OAAO,yFAAyF,CAAC;IACnG,CAAC;CA0IF;AAjJD,8CAiJC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/brand-folder/client.ts"],"names":[],"mappings":";;;AAAA,wDAA2D;AAE3D,uCAKmB;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAa,iBAAkB,SAAQ,+BAAiB;IACtD,YAAY,IAAgB,EAAE,OAAgB;QAC5C,KAAK,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,IAAI,oCAAoC,CAAC,CAAC;QAO/E;;;WAGG;QACH,gBAAW,GAAG;YACZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAgCG;YACH,GAAG,EAAE,KAAK,IAAI,EAAE;gBACd,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,eAAe;oBACrB,cAAc,EAAE,mCAAyB;iBAC1C,EACD,SAAS,CACV,CAAC;YACJ,CAAC;YAED;;;eAGG;YACH,OAAO,EAAE,KAAK,IAAqB,EAAE;gBACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;gBAC9C,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;SACF,CAAC;QAEF;;;WAGG;QACH,eAAU,GAAG;YACX;;;eAGG;YACH,KAAK,EAAE;gBACL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAwEG;gBACH,MAAM,EAAE,KAAK,EAAE,MAAkC,EAAE,EAAE;oBACnD,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,MAAM;wBACd,IAAI,EAAE,mBAAmB;wBACzB,cAAc,EAAE,qCAA2B;qBAC5C,EACD,MAAM,CACP,CAAC;gBACJ,CAAC;gBAED;;;;mBAIG;gBACH,OAAO,EAAE,KAAK,EAAE,MAAkC,EAAgC,EAAE;oBAClF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC5D,OAAO,QAAQ,CAAC,IAAI,CAAC;gBACvB,CAAC;aACF;SACF,CAAC;IAzKF,CAAC;IAES,qBAAqB;QAC7B,OAAO,yFAAyF,CAAC;IACnG,CAAC;CAsKF;AA7KD,8CA6KC"}

package/dist/cjs/services/brand-folder/schemas.d.ts

@@ -212,14 +212,14 @@ export declare const CategoryFocusResponseSchema: z.ZodEffects<z.ZodObject<{
         priority?: number | undefined;
         isActive?: boolean | undefined;
         displayOrder?: number | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
         categoryId?: string | undefined;
         categoryName?: string | undefined;
         categorySlug?: string | undefined;
         focusLevel?: string | undefined;
         visibility?: string | undefined;
         featured?: boolean | undefined;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
         effectiveDate?: string | undefined;
     } & {
         [k: string]: unknown;
@@ -239,14 +239,14 @@ export declare const CategoryFocusResponseSchema: z.ZodEffects<z.ZodObject<{
         priority?: number | undefined;
         isActive?: boolean | undefined;
         displayOrder?: number | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
         categoryId?: string | undefined;
         categoryName?: string | undefined;
         categorySlug?: string | undefined;
         focusLevel?: string | undefined;
         visibility?: string | undefined;
         featured?: boolean | undefined;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
         effectiveDate?: string | undefined;
     } & {
         [k: string]: unknown;
@@ -266,14 +266,14 @@ export declare const CategoryFocusResponseSchema: z.ZodEffects<z.ZodObject<{
         priority?: number | undefined;
         isActive?: boolean | undefined;
         displayOrder?: number | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
         categoryId?: string | undefined;
         categoryName?: string | undefined;
         categorySlug?: string | undefined;
         focusLevel?: string | undefined;
         visibility?: string | undefined;
         featured?: boolean | undefined;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
         effectiveDate?: string | undefined;
     } & {
         [k: string]: unknown;
@@ -293,14 +293,14 @@ export declare const CategoryFocusResponseSchema: z.ZodEffects<z.ZodObject<{
         priority?: number | undefined;
         isActive?: boolean | undefined;
         displayOrder?: number | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
         categoryId?: string | undefined;
         categoryName?: string | undefined;
         categorySlug?: string | undefined;
         focusLevel?: string | undefined;
         visibility?: string | undefined;
         featured?: boolean | undefined;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
         effectiveDate?: string | undefined;
     } & {
         [k: string]: unknown;