UNPKG

@simpleapps-com/augur-api

Version:

TypeScript client library for Augur microservices API endpoints

74 lines • 4.22 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
import { BaseServiceClient } from '../../core/base-client'; import type { HTTPClient } from '../../core/client'; import { type AttributeGroupsResource, type AttributeGroupsDataResource, type AttributesResource, type AttributesDataResource, type BrandsResource, type BrandsDataResource, type CategoriesResource, type CategoriesDataResource, type ContractsResource, type ContractsDataResource, type HealthCheckResource, type HealthCheckDataResource, type InternalResource, type InternalDataResource, type InvMastResource, type InvMastDataResource, type InvMastLinksResource, type InvMastLinksDataResource, type InvMastSubPartsResource, type InvMastSubPartsDataResource, type ItemCategoryResource, type ItemCategoryDataResource, type ItemFavoritesResource, type ItemFavoritesDataResource, type ItemUomResource, type ItemUomDataResource, type ItemWishlistResource, type ItemWishlistDataResource, type LocationsResource, type LocationsDataResource, type PingResource, type PingDataResource, type VariantsResource, type VariantsDataResource, type InvLocResource, type InvLocDataResource, type InvMastUdResource, type InvMastUdDataResource, type P21Resource, type P21DataResource } from './resources'; /** * Items service client implementing OpenAPI Path Mirroring Pattern * * **CRITICAL**: All client structures follow exact OpenAPI path segments * * This client provides access to the Items API with full type safety and validation. * All endpoints are organized by their OpenAPI path structure. * * @example * ```typescript * const client = new ItemsClient(httpClient); * * // Standard method - returns full response with metadata * const response = await client.invMast.list({ limit: 10 }); * console.log(response.data); // Array of items * console.log(response.total); // Total count * * // Data method - returns just the data * const items = await client.invMastData.list({ limit: 10 }); * console.log(items); // Array of items directly * ``` */ export declare class ItemsClient extends BaseServiceClient { readonly attributeGroups: AttributeGroupsResource; readonly attributes: AttributesResource; readonly brands: BrandsResource; readonly categories: CategoriesResource; readonly contracts: ContractsResource; readonly healthCheck: HealthCheckResource; readonly internal: InternalResource; readonly invMast: InvMastResource; readonly invMastLinks: InvMastLinksResource; readonly invMastSubParts: InvMastSubPartsResource; readonly itemCategory: ItemCategoryResource; readonly itemFavorites: ItemFavoritesResource; readonly itemUom: ItemUomResource; readonly itemWishlist: ItemWishlistResource; readonly locations: LocationsResource; readonly ping: PingResource; readonly variants: VariantsResource; readonly invLoc: InvLocResource; readonly invMastUd: InvMastUdResource; readonly p21: P21Resource; readonly attributeGroupsData: AttributeGroupsDataResource; readonly attributesData: AttributesDataResource; readonly brandsData: BrandsDataResource; readonly categoriesData: CategoriesDataResource; readonly contractsData: ContractsDataResource; readonly healthCheckData: HealthCheckDataResource; readonly internalData: InternalDataResource; readonly invMastData: InvMastDataResource; readonly invMastLinksData: InvMastLinksDataResource; readonly invMastSubPartsData: InvMastSubPartsDataResource; readonly itemCategoryData: ItemCategoryDataResource; readonly itemFavoritesData: ItemFavoritesDataResource; readonly itemUomData: ItemUomDataResource; readonly itemWishlistData: ItemWishlistDataResource; readonly locationsData: LocationsDataResource; readonly pingData: PingDataResource; readonly variantsData: VariantsDataResource; readonly invLocData: InvLocDataResource; readonly invMastUdData: InvMastUdDataResource; readonly p21Data: P21DataResource; /** * Create a new ItemsClient instance * @param http Configured HTTPClient instance * @param baseUrl Base URL for the Items API (default: https://items.augur-api.com) */ constructor(http: HTTPClient, baseUrl?: string); } //# sourceMappingURL=client.d.ts.map