@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
224 lines • 8.41 kB
JavaScript
import { StandardPaginationParamsSchema } from '../../../core/common-schemas';
import { CreateBrandRequestSchema, UpdateBrandRequestSchema, BrandListParamsSchema, BrandResponseSchema, BrandListResponseSchema, CreateBrandItemRequestSchema, UpdateBrandItemRequestSchema, BrandItemResponseSchema, BrandItemListResponseSchema, } from '../schemas';
/**
* Creates the brands resource methods
* OpenAPI Path: /brands → brands.*
* @description Methods for managing product brands
*/
export function createBrandsResource(executeRequest) {
return {
/**
* List all brands
* @description Retrieve a paginated list of brands with filtering options
* @fullPath api.items.brands.list
* @service items
* @domain inventory-management
* @discoverable true
* @dataMethod brandsData.list
*/
list: async (params) => {
return executeRequest({
method: 'GET',
path: '/brands',
paramsSchema: BrandListParamsSchema,
responseSchema: BrandListResponseSchema,
}, params);
},
/**
* Create new brand
* @description Create a new brand
* @fullPath api.items.brands.create
* @service items
* @domain inventory-management
* @discoverable true
*/
create: async (data) => {
return executeRequest({
method: 'POST',
path: '/brands',
paramsSchema: CreateBrandRequestSchema,
responseSchema: BrandResponseSchema,
}, data);
},
/**
* Get brand by ID
* @description Retrieve specific brand details
* @fullPath api.items.brands.get
* @service items
* @domain inventory-management
* @discoverable true
*/
get: async (brandsUid) => {
return executeRequest({
method: 'GET',
path: `/brands/${brandsUid}`,
responseSchema: BrandResponseSchema,
});
},
/**
* Update brand
* @description Update existing brand
* @fullPath api.items.brands.update
* @service items
* @domain inventory-management
* @discoverable true
*/
update: async (brandsUid, data) => {
return executeRequest({
method: 'PUT',
path: `/brands/${brandsUid}`,
paramsSchema: UpdateBrandRequestSchema,
responseSchema: BrandResponseSchema,
}, data);
},
/**
* Delete brand
* @description Delete existing brand
* @fullPath api.items.brands.delete
* @service items
* @domain inventory-management
* @discoverable true
*/
delete: async (brandsUid) => {
return executeRequest({
method: 'DELETE',
path: `/brands/${brandsUid}`,
responseSchema: BrandResponseSchema,
});
},
/**
* OpenAPI Path: /brands/{brandsUid}/items → brands.items.*
* @description Nested path for managing items within brands
*/
items: {
/**
* List brand items
* @description List all items associated with a brand
* @fullPath api.items.brands.items.list
* @service items
* @domain inventory-management
* @discoverable true
*/
list: async (brandsUid, params) => {
return executeRequest({
method: 'GET',
path: `/brands/${brandsUid}/items`,
paramsSchema: StandardPaginationParamsSchema,
responseSchema: BrandItemListResponseSchema,
}, params);
},
/**
* Add item to brand
* @description Create association between item and brand
* @fullPath api.items.brands.items.create
* @service items
* @domain inventory-management
* @discoverable true
*/
create: async (brandsUid, data) => {
return executeRequest({
method: 'POST',
path: `/brands/${brandsUid}/items`,
paramsSchema: CreateBrandItemRequestSchema,
responseSchema: BrandItemResponseSchema,
}, data);
},
/**
* Get brand item association
* @description Get specific brand-item association details
* @fullPath api.items.brands.items.get
* @service items
* @domain inventory-management
* @discoverable true
*/
get: async (brandsUid, brandsXItemsUid) => {
return executeRequest({
method: 'GET',
path: `/brands/${brandsUid}/items/${brandsXItemsUid}`,
responseSchema: BrandItemResponseSchema,
});
},
/**
* Update brand item association
* @description Update existing brand-item association
* @fullPath api.items.brands.items.update
* @service items
* @domain inventory-management
* @discoverable true
*/
update: async (brandsUid, brandsXItemsUid, data) => {
return executeRequest({
method: 'PUT',
path: `/brands/${brandsUid}/items/${brandsXItemsUid}`,
paramsSchema: UpdateBrandItemRequestSchema,
responseSchema: BrandItemResponseSchema,
}, data);
},
/**
* Remove item from brand
* @description Delete brand-item association
* @fullPath api.items.brands.items.delete
* @service items
* @domain inventory-management
* @discoverable true
*/
delete: async (brandsUid, brandsXItemsUid) => {
return executeRequest({
method: 'DELETE',
path: `/brands/${brandsUid}/items/${brandsXItemsUid}`,
responseSchema: BrandItemResponseSchema,
});
},
},
};
}
/**
* Creates the brandsData resource methods (data-only versions)
*/
export function createBrandsDataResource(brands) {
return {
list: async (params) => {
const response = await brands.list(params);
return response.data;
},
create: async (data) => {
const response = await brands.create(data);
return response.data;
},
get: async (brandsUid) => {
const response = await brands.get(brandsUid);
return response.data;
},
update: async (brandsUid, data) => {
const response = await brands.update(brandsUid, data);
return response.data;
},
delete: async (brandsUid) => {
const response = await brands.delete(brandsUid);
return response.data;
},
items: {
list: async (brandsUid, params) => {
const response = await brands.items.list(brandsUid, params);
return response.data;
},
create: async (brandsUid, data) => {
const response = await brands.items.create(brandsUid, data);
return response.data;
},
get: async (brandsUid, brandsXItemsUid) => {
const response = await brands.items.get(brandsUid, brandsXItemsUid);
return response.data;
},
update: async (brandsUid, brandsXItemsUid, data) => {
const response = await brands.items.update(brandsUid, brandsXItemsUid, data);
return response.data;
},
delete: async (brandsUid, brandsXItemsUid) => {
const response = await brands.items.delete(brandsUid, brandsXItemsUid);
return response.data;
},
},
};
}
//# sourceMappingURL=brands.js.map