@simpleapps-com/augur-api 0.4.6 → 0.4.8

package/dist/types/services/items/schemas/invMastLocationsBins.d.ts

@@ -1,64 +1,41 @@
 import { z } from 'zod';
 /**
- * Inventory location bin schema for nested path structure
- * OpenAPI: /inv-mast/{invMastUid}/locations/{locationId}/bins
- * OpenAPI: /inv-mast/{invMastUid}/locations/{locationId}/bins/{bin}
+ * Parameter schema for inventory master location bins list endpoint
+ * OpenAPI: /inv-mast/{invMastUid}/locations/{locationId}/bins GET
  */
-export declare const InvMastLocationBinSchema: z.ZodObject<{
-    invMastUid: z.ZodNumber;
-    locationId: z.ZodString;
-    bin: z.ZodString;
-    quantity: z.ZodNumber;
-    reserved: z.ZodOptional<z.ZodNumber>;
-    available: z.ZodOptional<z.ZodNumber>;
-    lastUpdated: z.ZodString;
+export declare const InvMastLocationsBinsParamsSchema: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    excludeZero: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    invMastUid: number;
-    quantity: number;
-    locationId: string;
-    bin: string;
-    lastUpdated: string;
-    reserved?: number | undefined;
-    available?: number | undefined;
+    limit: number;
+    offset: number;
+    excludeZero?: string | undefined;
 }, {
-    invMastUid: number;
-    quantity: number;
-    locationId: string;
-    bin: string;
-    lastUpdated: string;
-    reserved?: number | undefined;
-    available?: number | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+    excludeZero?: string | undefined;
 }>;
+/**
+ * Inventory location bin schema for nested path structure
+ * OpenAPI: /inv-mast/{invMastUid}/locations/{locationId}/bins
+ *
+ * Per OpenAPI specification, the response data is defined as:
+ * - "type": "array"
+ * - "items": { "type": "object" }
+ * - "description": "Array of objects (often DTOs)"
+ *
+ * The OpenAPI spec does NOT define specific object properties, only that
+ * data contains an array of generic objects. Following the OpenAPI spec exactly,
+ * we use z.record() to accept any object structure as the spec allows.
+ */
+export declare const InvMastLocationBinSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 /**
  * Response schemas for inv-mast locations bins endpoints
  */
 export declare const InvMastLocationBinResponseSchema: z.ZodEffects<z.ZodObject<{
     count: z.ZodNumber;
-    data: z.ZodObject<{
-        invMastUid: z.ZodNumber;
-        locationId: z.ZodString;
-        bin: z.ZodString;
-        quantity: z.ZodNumber;
-        reserved: z.ZodOptional<z.ZodNumber>;
-        available: z.ZodOptional<z.ZodNumber>;
-        lastUpdated: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    }, {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    }>;
+    data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     message: z.ZodString;
     options: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
     params: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
@@ -67,15 +44,7 @@ export declare const InvMastLocationBinResponseSchema: z.ZodEffects<z.ZodObject<
     totalResults: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     params: Record<string, unknown> | unknown[];
-    data: {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    };
+    data: Record<string, unknown>;
     options: Record<string, unknown> | unknown[];
     status: number;
     message: string;
@@ -84,15 +53,7 @@ export declare const InvMastLocationBinResponseSchema: z.ZodEffects<z.ZodObject<
     totalResults: number;
 }, {
     params: Record<string, unknown> | unknown[];
-    data: {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    };
+    data: Record<string, unknown>;
     options: Record<string, unknown> | unknown[];
     status: number;
     message: string;
@@ -101,15 +62,7 @@ export declare const InvMastLocationBinResponseSchema: z.ZodEffects<z.ZodObject<
     totalResults: number;
 }>, {
     params: Record<string, unknown> | unknown[];
-    data: {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    };
+    data: Record<string, unknown>;
     options: Record<string, unknown> | unknown[];
     status: number;
     message: string;
@@ -118,15 +71,7 @@ export declare const InvMastLocationBinResponseSchema: z.ZodEffects<z.ZodObject<
     totalResults: number;
 }, {
     params: Record<string, unknown> | unknown[];
-    data: {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    };
+    data: Record<string, unknown>;
     options: Record<string, unknown> | unknown[];
     status: number;
     message: string;
@@ -136,31 +81,7 @@ export declare const InvMastLocationBinResponseSchema: z.ZodEffects<z.ZodObject<
 }>;
 export declare const InvMastLocationBinListResponseSchema: z.ZodEffects<z.ZodObject<{
     count: z.ZodNumber;
-    data: z.ZodArray<z.ZodObject<{
-        invMastUid: z.ZodNumber;
-        locationId: z.ZodString;
-        bin: z.ZodString;
-        quantity: z.ZodNumber;
-        reserved: z.ZodOptional<z.ZodNumber>;
-        available: z.ZodOptional<z.ZodNumber>;
-        lastUpdated: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    }, {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    }>, "many">;
+    data: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
     message: z.ZodString;
     options: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
     params: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
@@ -169,15 +90,7 @@ export declare const InvMastLocationBinListResponseSchema: z.ZodEffects<z.ZodObj
     totalResults: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     params: Record<string, unknown> | unknown[];
-    data: {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    }[];
+    data: Record<string, unknown>[];
     options: Record<string, unknown> | unknown[];
     status: number;
     message: string;
@@ -186,15 +99,7 @@ export declare const InvMastLocationBinListResponseSchema: z.ZodEffects<z.ZodObj
     totalResults: number;
 }, {
     params: Record<string, unknown> | unknown[];
-    data: {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    }[];
+    data: Record<string, unknown>[];
     options: Record<string, unknown> | unknown[];
     status: number;
     message: string;
@@ -203,15 +108,7 @@ export declare const InvMastLocationBinListResponseSchema: z.ZodEffects<z.ZodObj
     totalResults: number;
 }>, {
     params: Record<string, unknown> | unknown[];
-    data: {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    }[];
+    data: Record<string, unknown>[];
     options: Record<string, unknown> | unknown[];
     status: number;
     message: string;
@@ -220,15 +117,7 @@ export declare const InvMastLocationBinListResponseSchema: z.ZodEffects<z.ZodObj
     totalResults: number;
 }, {
     params: Record<string, unknown> | unknown[];
-    data: {
-        invMastUid: number;
-        quantity: number;
-        locationId: string;
-        bin: string;
-        lastUpdated: string;
-        reserved?: number | undefined;
-        available?: number | undefined;
-    }[];
+    data: Record<string, unknown>[];
     options: Record<string, unknown> | unknown[];
     status: number;
     message: string;
@@ -236,6 +125,7 @@ export declare const InvMastLocationBinListResponseSchema: z.ZodEffects<z.ZodObj
     total: number;
     totalResults: number;
 }>;
+export type InvMastLocationsBinsParams = z.infer<typeof InvMastLocationsBinsParamsSchema>;
 export type InvMastLocationBin = z.infer<typeof InvMastLocationBinSchema>;
 export type InvMastLocationBinResponse = z.infer<typeof InvMastLocationBinResponseSchema>;
 export type InvMastLocationBinListResponse = z.infer<typeof InvMastLocationBinListResponseSchema>;

package/dist/types/services/items/schemas/invMastLocationsBins.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invMastLocationsBins.d.ts","sourceRoot":"","sources":["../../../../../src/services/items/schemas/invMastLocationsBins.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;EAQnC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA+C,CAAC;AAC7F,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEhD,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAC1F,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC"}
+{"version":3,"file":"invMastLocationsBins.d.ts","sourceRoot":"","sources":["../../../../../src/services/items/schemas/invMastLocationsBins.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;EAI3C,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,wBAAwB,wCAAwB,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA+C,CAAC;AAC7F,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEhD,CAAC;AAGF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAC1F,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAC1F,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC"}

package/dist/types/services/items/schemas/invMastLookup.d.ts

@@ -0,0 +1,185 @@
+import { z } from 'zod';
+/**
+ * Parameter schema for inventory master lookup endpoint
+ * OpenAPI: /inv-mast/lookup GET
+ */
+export declare const InvMastLookupParamsSchema: z.ZodObject<{
+    q: z.ZodString;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    statusCd: z.ZodOptional<z.ZodNumber>;
+    onlineCd: z.ZodOptional<z.ZodNumber>;
+    orderBy: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    q: string;
+    limit?: number | undefined;
+    offset?: number | undefined;
+    orderBy?: string | undefined;
+    statusCd?: number | undefined;
+    onlineCd?: number | undefined;
+}, {
+    q: string;
+    limit?: number | undefined;
+    offset?: number | undefined;
+    orderBy?: string | undefined;
+    statusCd?: number | undefined;
+    onlineCd?: number | undefined;
+}>;
+/**
+ * Product lookup result schema for inventory master lookup
+ * OpenAPI: /inv-mast/lookup
+ */
+export declare const InvMastLookupResultSchema: z.ZodObject<{
+    invMastUid: z.ZodNumber;
+    itemId: z.ZodString;
+    itemDesc: z.ZodString;
+    categoryId: z.ZodOptional<z.ZodString>;
+    brandName: z.ZodOptional<z.ZodString>;
+    statusCd: z.ZodOptional<z.ZodNumber>;
+    onlineCd: z.ZodOptional<z.ZodNumber>;
+    unitPrice: z.ZodOptional<z.ZodNumber>;
+    availability: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    invMastUid: number;
+    itemId: string;
+    itemDesc: string;
+    statusCd?: number | undefined;
+    unitPrice?: number | undefined;
+    onlineCd?: number | undefined;
+    brandName?: string | undefined;
+    categoryId?: string | undefined;
+    availability?: string | undefined;
+}, {
+    invMastUid: number;
+    itemId: string;
+    itemDesc: string;
+    statusCd?: number | undefined;
+    unitPrice?: number | undefined;
+    onlineCd?: number | undefined;
+    brandName?: string | undefined;
+    categoryId?: string | undefined;
+    availability?: string | undefined;
+}>;
+/**
+ * Response schema for inventory master lookup endpoint
+ */
+export declare const InvMastLookupResponseSchema: z.ZodEffects<z.ZodObject<{
+    count: z.ZodNumber;
+    data: z.ZodArray<z.ZodObject<{
+        invMastUid: z.ZodNumber;
+        itemId: z.ZodString;
+        itemDesc: z.ZodString;
+        categoryId: z.ZodOptional<z.ZodString>;
+        brandName: z.ZodOptional<z.ZodString>;
+        statusCd: z.ZodOptional<z.ZodNumber>;
+        onlineCd: z.ZodOptional<z.ZodNumber>;
+        unitPrice: z.ZodOptional<z.ZodNumber>;
+        availability: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        invMastUid: number;
+        itemId: string;
+        itemDesc: string;
+        statusCd?: number | undefined;
+        unitPrice?: number | undefined;
+        onlineCd?: number | undefined;
+        brandName?: string | undefined;
+        categoryId?: string | undefined;
+        availability?: string | undefined;
+    }, {
+        invMastUid: number;
+        itemId: string;
+        itemDesc: string;
+        statusCd?: number | undefined;
+        unitPrice?: number | undefined;
+        onlineCd?: number | undefined;
+        brandName?: string | undefined;
+        categoryId?: string | undefined;
+        availability?: string | undefined;
+    }>, "many">;
+    message: z.ZodString;
+    options: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+    params: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+    status: z.ZodNumber;
+    total: z.ZodNumber;
+    totalResults: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    params: Record<string, unknown> | unknown[];
+    data: {
+        invMastUid: number;
+        itemId: string;
+        itemDesc: string;
+        statusCd?: number | undefined;
+        unitPrice?: number | undefined;
+        onlineCd?: number | undefined;
+        brandName?: string | undefined;
+        categoryId?: string | undefined;
+        availability?: string | undefined;
+    }[];
+    options: Record<string, unknown> | unknown[];
+    status: number;
+    message: string;
+    count: number;
+    total: number;
+    totalResults: number;
+}, {
+    params: Record<string, unknown> | unknown[];
+    data: {
+        invMastUid: number;
+        itemId: string;
+        itemDesc: string;
+        statusCd?: number | undefined;
+        unitPrice?: number | undefined;
+        onlineCd?: number | undefined;
+        brandName?: string | undefined;
+        categoryId?: string | undefined;
+        availability?: string | undefined;
+    }[];
+    options: Record<string, unknown> | unknown[];
+    status: number;
+    message: string;
+    count: number;
+    total: number;
+    totalResults: number;
+}>, {
+    params: Record<string, unknown> | unknown[];
+    data: {
+        invMastUid: number;
+        itemId: string;
+        itemDesc: string;
+        statusCd?: number | undefined;
+        unitPrice?: number | undefined;
+        onlineCd?: number | undefined;
+        brandName?: string | undefined;
+        categoryId?: string | undefined;
+        availability?: string | undefined;
+    }[];
+    options: Record<string, unknown> | unknown[];
+    status: number;
+    message: string;
+    count: number;
+    total: number;
+    totalResults: number;
+}, {
+    params: Record<string, unknown> | unknown[];
+    data: {
+        invMastUid: number;
+        itemId: string;
+        itemDesc: string;
+        statusCd?: number | undefined;
+        unitPrice?: number | undefined;
+        onlineCd?: number | undefined;
+        brandName?: string | undefined;
+        categoryId?: string | undefined;
+        availability?: string | undefined;
+    }[];
+    options: Record<string, unknown> | unknown[];
+    status: number;
+    message: string;
+    count: number;
+    total: number;
+    totalResults: number;
+}>;
+export type InvMastLookupParams = z.infer<typeof InvMastLookupParamsSchema>;
+export type InvMastLookupResult = z.infer<typeof InvMastLookupResultSchema>;
+export type InvMastLookupResponse = z.infer<typeof InvMastLookupResponseSchema>;
+//# sourceMappingURL=invMastLookup.d.ts.map

package/dist/types/services/items/schemas/invMastLookup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invMastLookup.d.ts","sourceRoot":"","sources":["../../../../../src/services/items/schemas/invMastLookup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;GAGG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;EAOpC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUpC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAyD,CAAC;AAGlG,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simpleapps-com/augur-api",
-  "version": "0.4.6",
+  "version": "0.4.8",
   "description": "TypeScript client library for Augur microservices API endpoints",
   "keywords": [
     "augur",
@@ -31,7 +31,8 @@
     "API-DISCOVERY.md",
     "API-SERVICES.md",
     "AUTHENTICATION.md",
-    "PERFORMANCE.md"
+    "PERFORMANCE.md",
+    "TIPS-AND-TRICKS.md"
   ],
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm && npm run build:types && npm run build:package-json",