@simpleapps-com/augur-api 0.4.1 → 0.4.2

package/dist/esm/services/items/client.d.ts

@@ -1,6 +1,6 @@
 import { BaseServiceClient } from '../../core/base-client';
 import type { HTTPClient } from '../../core/client';
-import { CreateAttributeRequest, UpdateAttributeRequest, CreateAttributeGroupRequest, UpdateAttributeGroupRequest, AttributeGroupListParams, CreateBrandRequest, UpdateBrandRequest, BrandListParams, CategoryListParams, CategoryLookupParams, ProductListParams, ProductLookupParams, GetStockParams, CreateItemVariantHeaderRequest, UpdateItemVariantHeaderRequest, ItemVariantListParams, CreateItemWishlistHeaderRequest, CreateAttributeGroupAttributeRequest, UpdateAttributeGroupAttributeRequest, CreateAttributeValueRequest, UpdateAttributeValueRequest, CreateBrandItemRequest, UpdateBrandItemRequest, CreateInvMastFaqRequest, UpdateInvMastFaqRequest, CreateItemWishlistHdrRequest, CreateItemAttributeValueRequest, CreateItemFavoriteRequest, UpdateItemFavoriteRequest } from './schemas';
+import { CreateAttributeRequest, UpdateAttributeRequest, CreateAttributeGroupRequest, UpdateAttributeGroupRequest, AttributeGroupListParams, CreateBrandRequest, UpdateBrandRequest, BrandListParams, CategoryListParams, CategoryLookupParams, ProductListParams, ProductLookupParams, GetStockParams, CreateItemVariantHeaderRequest, UpdateItemVariantHeaderRequest, ItemVariantListParams, CreateItemWishlistHeaderRequest, CreateAttributeGroupAttributeRequest, UpdateAttributeGroupAttributeRequest, CreateAttributeValueRequest, UpdateAttributeValueRequest, CreateBrandItemRequest, UpdateBrandItemRequest, CreateInvMastFaqRequest, UpdateInvMastFaqRequest, CreateItemWishlistHdrRequest, CreateItemAttributeValueRequest, CreateItemFavoriteRequest, UpdateItemFavoriteRequest, CreateInternalPdfRequest, UpdateItemAttributeValueRequest } from './schemas';
 /**
  * Items service client implementing OpenAPI Path Mirroring Pattern
  *
@@ -192,9 +192,9 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     attributeUid: number;
-                    attributeGroupUid: number;
                     createdAt: string;
                     updatedAt: string;
+                    attributeGroupUid: number;
                     attributeXAttributeGroupUid: number;
                     sequenceNo?: number | undefined;
                 }[];
@@ -217,9 +217,9 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     attributeUid: number;
-                    attributeGroupUid: number;
                     createdAt: string;
                     updatedAt: string;
+                    attributeGroupUid: number;
                     attributeXAttributeGroupUid: number;
                     sequenceNo?: number | undefined;
                 };
@@ -242,9 +242,9 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     attributeUid: number;
-                    attributeGroupUid: number;
                     createdAt: string;
                     updatedAt: string;
+                    attributeGroupUid: number;
                     attributeXAttributeGroupUid: number;
                     sequenceNo?: number | undefined;
                 };
@@ -267,9 +267,9 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     attributeUid: number;
-                    attributeGroupUid: number;
                     createdAt: string;
                     updatedAt: string;
+                    attributeGroupUid: number;
                     attributeXAttributeGroupUid: number;
                     sequenceNo?: number | undefined;
                 };
@@ -292,9 +292,9 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     attributeUid: number;
-                    attributeGroupUid: number;
                     createdAt: string;
                     updatedAt: string;
+                    attributeGroupUid: number;
                     attributeXAttributeGroupUid: number;
                     sequenceNo?: number | undefined;
                 };
@@ -952,23 +952,12 @@ export declare class ItemsClient extends BaseServiceClient {
             data: {
                 itemCategoryUid: number;
                 itemCategoryDesc: string;
-                path?: string;
-                parentItemCategoryUid?: number;
-                level?: number;
-                children?: Array<{
-                    itemCategoryUid: number;
-                    itemCategoryDesc: string;
-                    path?: string;
-                    parentItemCategoryUid?: number;
-                    level?: number;
-                    children?: unknown;
-                    attributes?: unknown[];
-                    images?: unknown[];
-                    itemCount?: number;
-                }>;
-                attributes?: unknown[];
-                images?: unknown[];
-                itemCount?: number;
+                path?: string | undefined;
+                attributes?: unknown[] | undefined;
+                images?: unknown[] | undefined;
+                itemCount?: number | undefined;
+                parentItemCategoryUid?: number | undefined;
+                level?: number | undefined;
             };
             options: Record<string, unknown> | unknown[];
             status: number;
@@ -1119,15 +1108,15 @@ export declare class ItemsClient extends BaseServiceClient {
              * @domain document-generation
              * @discoverable true
              */
-            create: (data: Record<string, unknown>) => Promise<{
+            create: (data: CreateInternalPdfRequest) => Promise<{
                 params: Record<string, unknown> | unknown[];
                 data: {
+                    createdAt: string;
                     documentType: string;
                     pdfId: string;
                     fileName: string;
                     fileSize: number;
                     downloadUrl: string;
-                    createdAt: string;
                     expiresAt?: string | undefined;
                 };
                 options: Record<string, unknown> | unknown[];
@@ -1451,7 +1440,7 @@ export declare class ItemsClient extends BaseServiceClient {
                  * @domain inventory-management
                  * @discoverable true
                  */
-                update: (invMastUid: number, attributeUid: number, attributeValueUid: number, data: Record<string, unknown>) => Promise<{
+                update: (invMastUid: number, attributeUid: number, attributeValueUid: number, data: UpdateItemAttributeValueRequest) => Promise<{
                     params: Record<string, unknown> | unknown[];
                     data: {
                         invMastUid: number;
@@ -1507,14 +1496,22 @@ export declare class ItemsClient extends BaseServiceClient {
              * @discoverable true
              */
             list: (invMastUid: number) => Promise<{
-                data: any[];
-                status: string;
+                params: Record<string, unknown> | unknown[];
+                data: {
+                    invMastUid: number;
+                    documentType?: string | undefined;
+                    documentName?: string | undefined;
+                    documentUrl?: string | undefined;
+                    documentContent?: string | undefined;
+                    createdDate?: string | undefined;
+                    modifiedDate?: string | undefined;
+                }[];
+                options: Record<string, unknown> | unknown[];
+                status: number;
                 message: string;
-                limit: number;
+                count: number;
                 total: number;
-                timestamp: string;
-                requestId: string;
-                page: number;
+                totalResults: number;
             }>;
         };
         /**
@@ -1534,12 +1531,12 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     invMastUid: number;
+                    createdAt: string;
+                    updatedAt: string;
                     isActive: boolean;
                     invMastFaqUid: number;
                     question: string;
                     answer: string;
-                    createdAt: string;
-                    updatedAt: string;
                     sequenceNo?: number | undefined;
                     categoryId?: string | undefined;
                     votes?: number | undefined;
@@ -1564,12 +1561,12 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     invMastUid: number;
+                    createdAt: string;
+                    updatedAt: string;
                     isActive: boolean;
                     invMastFaqUid: number;
                     question: string;
                     answer: string;
-                    createdAt: string;
-                    updatedAt: string;
                     sequenceNo?: number | undefined;
                     categoryId?: string | undefined;
                     votes?: number | undefined;
@@ -1594,12 +1591,12 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     invMastUid: number;
+                    createdAt: string;
+                    updatedAt: string;
                     isActive: boolean;
                     invMastFaqUid: number;
                     question: string;
                     answer: string;
-                    createdAt: string;
-                    updatedAt: string;
                     sequenceNo?: number | undefined;
                     categoryId?: string | undefined;
                     votes?: number | undefined;
@@ -1624,12 +1621,12 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     invMastUid: number;
+                    createdAt: string;
+                    updatedAt: string;
                     isActive: boolean;
                     invMastFaqUid: number;
                     question: string;
                     answer: string;
-                    createdAt: string;
-                    updatedAt: string;
                     sequenceNo?: number | undefined;
                     categoryId?: string | undefined;
                     votes?: number | undefined;
@@ -1654,12 +1651,12 @@ export declare class ItemsClient extends BaseServiceClient {
                 params: Record<string, unknown> | unknown[];
                 data: {
                     invMastUid: number;
+                    createdAt: string;
+                    updatedAt: string;
                     isActive: boolean;
                     invMastFaqUid: number;
                     question: string;
                     answer: string;
-                    createdAt: string;
-                    updatedAt: string;
                     sequenceNo?: number | undefined;
                     categoryId?: string | undefined;
                     votes?: number | undefined;
@@ -1824,14 +1821,21 @@ export declare class ItemsClient extends BaseServiceClient {
              * @discoverable true
              */
             list: (invMastUid: number) => Promise<{
-                data: any[];
-                status: string;
+                params: Record<string, unknown> | unknown[];
+                data: {
+                    invMastUid: number;
+                    similarInvMastUid: number;
+                    description?: string | undefined;
+                    category?: string | undefined;
+                    partNumber?: string | undefined;
+                    similarityScore?: number | undefined;
+                }[];
+                options: Record<string, unknown> | unknown[];
+                status: number;
                 message: string;
-                limit: number;
+                count: number;
                 total: number;
-                timestamp: string;
-                requestId: string;
-                page: number;
+                totalResults: number;
             }>;
         };
         /**
@@ -2062,23 +2066,12 @@ export declare class ItemsClient extends BaseServiceClient {
             data: {
                 itemCategoryUid: number;
                 itemCategoryDesc: string;
-                path?: string;
-                parentItemCategoryUid?: number;
-                level?: number;
-                children?: Array<{
-                    itemCategoryUid: number;
-                    itemCategoryDesc: string;
-                    path?: string;
-                    parentItemCategoryUid?: number;
-                    level?: number;
-                    children?: unknown;
-                    attributes?: unknown[];
-                    images?: unknown[];
-                    itemCount?: number;
-                }>;
-                attributes?: unknown[];
-                images?: unknown[];
-                itemCount?: number;
+                path?: string | undefined;
+                attributes?: unknown[] | undefined;
+                images?: unknown[] | undefined;
+                itemCount?: number | undefined;
+                parentItemCategoryUid?: number | undefined;
+                level?: number | undefined;
             };
             options: Record<string, unknown> | unknown[];
             status: number;
@@ -2101,14 +2094,22 @@ export declare class ItemsClient extends BaseServiceClient {
              * @discoverable true
              */
             list: (itemCategoryUid: number) => Promise<{
-                data: any[];
-                status: string;
+                params: Record<string, unknown> | unknown[];
+                data: {
+                    itemCategoryUid: number;
+                    documentType?: string | undefined;
+                    documentName?: string | undefined;
+                    documentUrl?: string | undefined;
+                    documentContent?: string | undefined;
+                    createdDate?: string | undefined;
+                    modifiedDate?: string | undefined;
+                }[];
+                options: Record<string, unknown> | unknown[];
+                status: number;
                 message: string;
-                limit: number;
+                count: number;
                 total: number;
-                timestamp: string;
-                requestId: string;
-                page: number;
+                totalResults: number;
             }>;
         };
     };
@@ -2153,7 +2154,7 @@ export declare class ItemsClient extends BaseServiceClient {
          * @domain user-preferences
          * @discoverable true
          */
-        create: (usersId: string, data: Record<string, unknown>) => Promise<{
+        create: (usersId: string, data: CreateItemFavoriteRequest) => Promise<{
             params: Record<string, unknown> | unknown[];
             data: {
                 invMastUid: number;
@@ -2181,7 +2182,7 @@ export declare class ItemsClient extends BaseServiceClient {
          * @domain user-preferences
          * @discoverable true
          */
-        update: (usersId: string, invMastUid: number, data: Record<string, unknown>) => Promise<{
+        update: (usersId: string, invMastUid: number, data: UpdateItemFavoriteRequest) => Promise<{
             params: Record<string, unknown> | unknown[];
             data: {
                 invMastUid: number;
@@ -2311,11 +2312,11 @@ export declare class ItemsClient extends BaseServiceClient {
                 data: {
                     name: string;
                     usersId: string;
+                    createdAt: string;
+                    updatedAt: string;
                     itemWishlistHdrUid: number;
                     isPublic: boolean;
                     isDefault: boolean;
-                    createdAt: string;
-                    updatedAt: string;
                     description?: string | undefined;
                     itemCount?: number | undefined;
                 };
@@ -2339,11 +2340,11 @@ export declare class ItemsClient extends BaseServiceClient {
                 data: {
                     name: string;
                     usersId: string;
+                    createdAt: string;
+                    updatedAt: string;
                     itemWishlistHdrUid: number;
                     isPublic: boolean;
                     isDefault: boolean;
-                    createdAt: string;
-                    updatedAt: string;
                     description?: string | undefined;
                     itemCount?: number | undefined;
                 };
@@ -2372,10 +2373,10 @@ export declare class ItemsClient extends BaseServiceClient {
                     data: {
                         invMastUid: number;
                         quantity: number;
-                        itemWishlistHdrUid: number;
-                        itemWishlistLineUid: number;
                         createdAt: string;
                         updatedAt: string;
+                        itemWishlistHdrUid: number;
+                        itemWishlistLineUid: number;
                         notes?: string | undefined;
                         priority?: number | undefined;
                     };
@@ -2409,13 +2410,7 @@ export declare class ItemsClient extends BaseServiceClient {
              */
             list: (locationId: string, params?: Record<string, unknown>) => Promise<{
                 params: Record<string, unknown> | unknown[];
-                data: {
-                    locationId: string;
-                    bin: string;
-                    qtyOnHand?: number | undefined;
-                    qtyAllocated?: number | undefined;
-                    qtyAvailable?: number | undefined;
-                }[];
+                data: import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">[];
                 options: Record<string, unknown> | unknown[];
                 status: number;
                 message: string;
@@ -2432,14 +2427,14 @@ export declare class ItemsClient extends BaseServiceClient {
              * @discoverable true
              */
             get: (locationId: string, bin: string) => Promise<{
-                status: string;
+                params: Record<string, unknown> | unknown[];
+                data: import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">[];
+                options: Record<string, unknown> | unknown[];
+                status: number;
                 message: string;
-                limit: number;
+                count: number;
                 total: number;
-                timestamp: string;
-                requestId: string;
-                page: number;
-                data?: any;
+                totalResults: number;
             }>;
         };
     };
@@ -2709,41 +2704,41 @@ export declare class ItemsClient extends BaseServiceClient {
         attributes: {
             list: (attributeGroupUid: number, params?: Record<string, unknown>) => Promise<{
                 attributeUid: number;
-                attributeGroupUid: number;
                 createdAt: string;
                 updatedAt: string;
+                attributeGroupUid: number;
                 attributeXAttributeGroupUid: number;
                 sequenceNo?: number | undefined;
             }[]>;
             create: (attributeGroupUid: number, data: CreateAttributeGroupAttributeRequest) => Promise<{
                 attributeUid: number;
-                attributeGroupUid: number;
                 createdAt: string;
                 updatedAt: string;
+                attributeGroupUid: number;
                 attributeXAttributeGroupUid: number;
                 sequenceNo?: number | undefined;
             }>;
             get: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
                 attributeUid: number;
-                attributeGroupUid: number;
                 createdAt: string;
                 updatedAt: string;
+                attributeGroupUid: number;
                 attributeXAttributeGroupUid: number;
                 sequenceNo?: number | undefined;
             }>;
             update: (attributeGroupUid: number, attributeXAttributeGroupUid: number, data: UpdateAttributeGroupAttributeRequest) => Promise<{
                 attributeUid: number;
-                attributeGroupUid: number;
                 createdAt: string;
                 updatedAt: string;
+                attributeGroupUid: number;
                 attributeXAttributeGroupUid: number;
                 sequenceNo?: number | undefined;
             }>;
             delete: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
                 attributeUid: number;
-                attributeGroupUid: number;
                 createdAt: string;
                 updatedAt: string;
+                attributeGroupUid: number;
                 attributeXAttributeGroupUid: number;
                 sequenceNo?: number | undefined;
             }>;
@@ -3010,23 +3005,12 @@ export declare class ItemsClient extends BaseServiceClient {
         get: (itemCategoryUid: number) => Promise<{
             itemCategoryUid: number;
             itemCategoryDesc: string;
-            path?: string;
-            parentItemCategoryUid?: number;
-            level?: number;
-            children?: Array<{
-                itemCategoryUid: number;
-                itemCategoryDesc: string;
-                path?: string;
-                parentItemCategoryUid?: number;
-                level?: number;
-                children?: unknown;
-                attributes?: unknown[];
-                images?: unknown[];
-                itemCount?: number;
-            }>;
-            attributes?: unknown[];
-            images?: unknown[];
-            itemCount?: number;
+            path?: string | undefined;
+            attributes?: unknown[] | undefined;
+            images?: unknown[] | undefined;
+            itemCount?: number | undefined;
+            parentItemCategoryUid?: number | undefined;
+            level?: number | undefined;
         }>;
         attributes: {
             list: (itemCategoryUid: number) => Promise<{
@@ -3063,13 +3047,13 @@ export declare class ItemsClient extends BaseServiceClient {
     };
     internalData: {
         pdf: {
-            create: (data: Record<string, unknown>) => Promise<{
+            create: (data: CreateInternalPdfRequest) => Promise<{
+                createdAt: string;
                 documentType: string;
                 pdfId: string;
                 fileName: string;
                 fileSize: number;
                 downloadUrl: string;
-                createdAt: string;
                 expiresAt?: string | undefined;
             }>;
         };
@@ -3211,17 +3195,25 @@ export declare class ItemsClient extends BaseServiceClient {
             };
         };
         doc: {
-            list: (invMastUid: number) => Promise<any[]>;
+            list: (invMastUid: number) => Promise<{
+                invMastUid: number;
+                documentType?: string | undefined;
+                documentName?: string | undefined;
+                documentUrl?: string | undefined;
+                documentContent?: string | undefined;
+                createdDate?: string | undefined;
+                modifiedDate?: string | undefined;
+            }[]>;
         };
         faq: {
             list: (invMastUid: number, params?: Record<string, unknown>) => Promise<{
                 invMastUid: number;
+                createdAt: string;
+                updatedAt: string;
                 isActive: boolean;
                 invMastFaqUid: number;
                 question: string;
                 answer: string;
-                createdAt: string;
-                updatedAt: string;
                 sequenceNo?: number | undefined;
                 categoryId?: string | undefined;
                 votes?: number | undefined;
@@ -3229,12 +3221,12 @@ export declare class ItemsClient extends BaseServiceClient {
             }[]>;
             get: (invMastUid: number, invMastFaqUid: number) => Promise<{
                 invMastUid: number;
+                createdAt: string;
+                updatedAt: string;
                 isActive: boolean;
                 invMastFaqUid: number;
                 question: string;
                 answer: string;
-                createdAt: string;
-                updatedAt: string;
                 sequenceNo?: number | undefined;
                 categoryId?: string | undefined;
                 votes?: number | undefined;
@@ -3295,7 +3287,14 @@ export declare class ItemsClient extends BaseServiceClient {
             };
         };
         similar: {
-            list: (invMastUid: number) => Promise<any[]>;
+            list: (invMastUid: number) => Promise<{
+                invMastUid: number;
+                similarInvMastUid: number;
+                description?: string | undefined;
+                category?: string | undefined;
+                partNumber?: string | undefined;
+                similarityScore?: number | undefined;
+            }[]>;
         };
         stock: {
             get: (invMastUid: number, params?: GetStockParams) => Promise<{
@@ -3410,26 +3409,23 @@ export declare class ItemsClient extends BaseServiceClient {
         get: (itemCategoryUid: number) => Promise<{
             itemCategoryUid: number;
             itemCategoryDesc: string;
-            path?: string;
-            parentItemCategoryUid?: number;
-            level?: number;
-            children?: Array<{
-                itemCategoryUid: number;
-                itemCategoryDesc: string;
-                path?: string;
-                parentItemCategoryUid?: number;
-                level?: number;
-                children?: unknown;
-                attributes?: unknown[];
-                images?: unknown[];
-                itemCount?: number;
-            }>;
-            attributes?: unknown[];
-            images?: unknown[];
-            itemCount?: number;
+            path?: string | undefined;
+            attributes?: unknown[] | undefined;
+            images?: unknown[] | undefined;
+            itemCount?: number | undefined;
+            parentItemCategoryUid?: number | undefined;
+            level?: number | undefined;
         }>;
         doc: {
-            list: (itemCategoryUid: number) => Promise<any[]>;
+            list: (itemCategoryUid: number) => Promise<{
+                itemCategoryUid: number;
+                documentType?: string | undefined;
+                documentName?: string | undefined;
+                documentUrl?: string | undefined;
+                documentContent?: string | undefined;
+                createdDate?: string | undefined;
+                modifiedDate?: string | undefined;
+            }[]>;
         };
     };
     itemFavoritesData: {
@@ -3507,22 +3503,22 @@ export declare class ItemsClient extends BaseServiceClient {
             get: (usersId: string, itemWishlistHdrUid: number) => Promise<{
                 name: string;
                 usersId: string;
+                createdAt: string;
+                updatedAt: string;
                 itemWishlistHdrUid: number;
                 isPublic: boolean;
                 isDefault: boolean;
-                createdAt: string;
-                updatedAt: string;
                 description?: string | undefined;
                 itemCount?: number | undefined;
             }>;
             create: (usersId: string, itemWishlistHdrUid: number, data: CreateItemWishlistHdrRequest) => Promise<{
                 name: string;
                 usersId: string;
+                createdAt: string;
+                updatedAt: string;
                 itemWishlistHdrUid: number;
                 isPublic: boolean;
                 isDefault: boolean;
-                createdAt: string;
-                updatedAt: string;
                 description?: string | undefined;
                 itemCount?: number | undefined;
             }>;
@@ -3530,10 +3526,10 @@ export declare class ItemsClient extends BaseServiceClient {
                 delete: (usersId: string, itemWishlistHdrUid: number, itemWishlistLineUid: number) => Promise<{
                     invMastUid: number;
                     quantity: number;
-                    itemWishlistHdrUid: number;
-                    itemWishlistLineUid: number;
                     createdAt: string;
                     updatedAt: string;
+                    itemWishlistHdrUid: number;
+                    itemWishlistLineUid: number;
                     notes?: string | undefined;
                     priority?: number | undefined;
                 }>;
@@ -3542,14 +3538,8 @@ export declare class ItemsClient extends BaseServiceClient {
     };
     locationsData: {
         bins: {
-            list: (locationId: string, params?: Record<string, unknown>) => Promise<{
-                locationId: string;
-                bin: string;
-                qtyOnHand?: number | undefined;
-                qtyAllocated?: number | undefined;
-                qtyAvailable?: number | undefined;
-            }[]>;
-            get: (locationId: string, bin: string) => Promise<any>;
+            list: (locationId: string, params?: Record<string, unknown>) => Promise<import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">[]>;
+            get: (locationId: string, bin: string) => Promise<import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">[]>;
         };
     };
     variantsData: {