@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
56 lines • 2.44 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.createInvMastUdResource = createInvMastUdResource;
exports.createInvMastUdDataResource = createInvMastUdDataResource;
const schemas_1 = require("../schemas");
/**
* Creates the invMastUd resource methods
* OpenAPI Path: /inv-mast-ud → invMastUd.*
* @description Inventory Master User-Defined fields endpoints
*/
function createInvMastUdResource(executeRequest) {
return {
/**
* List inventory master user-defined records
* @description Retrieve a paginated list of inv_mast_ud records with filtering
* @fullPath api.items.invMastUd.list
* @service items
* @domain inventory-management
* @dataMethod invMastUdData.list
* @discoverable true
* @searchTerms ["inv mast ud", "user defined", "custom fields", "inventory extensions"]
* @relatedEndpoints ["api.items.invMast.list", "api.items.invMast.get"]
* @commonPatterns ["List user-defined data", "Filter by invMastUid", "Date filtering"]
* @workflow ["inventory-management", "custom-data"]
* @prerequisites ["Valid authentication", "Bearer token", "x-site-id header"]
* @nextSteps ["Link to invMast records", "Process custom fields"]
* @businessRules ["Returns inv_mast_ud records", "Supports date filtering", "Supports status filtering"]
* @functionalArea "inventory-management"
* @caching "Variable TTL based on cacheTtl parameter"
* @performance "Good - supports filtering and pagination"
*
* @param params Optional filtering and pagination parameters
* @returns Promise<InvMastUdListResponse> Complete response with user-defined records array
*/
list: async (params) => {
return executeRequest({
method: 'GET',
path: '/inv-mast-ud',
paramsSchema: schemas_1.InvMastUdListParamsSchema,
responseSchema: schemas_1.InvMastUdListResponseSchema,
}, params);
},
};
}
/**
* Creates the invMastUdData resource methods (data-only versions)
*/
function createInvMastUdDataResource(invMastUd) {
return {
list: async (params) => {
const response = await invMastUd.list(params);
return response.data;
},
};
}
//# sourceMappingURL=inv-mast-ud.js.map