UNPKG

@simpleapps-com/augur-api

Version:

TypeScript client library for Augur microservices API endpoints

60 lines 2.58 kB
import { BaseServiceClient } from '../../core/base-client'; import type { HTTPClient } from '../../core/client'; import { type HealthCheckResource, type HealthCheckDataResource, type InvMastExtResource, type InvMastExtDataResource, type ItemsResource, type ItemsDataResource, type PodcastsResource, type PodcastsDataResource } from './resources'; /** * P21 PIM (Product Information Management) API client * * Provides access to extended inventory data, AI-powered content generation, * and podcast management capabilities. * * @fullPath api.p21Pim * @service p21-pim * @domain product-information-management * @discoverable true * @searchTerms ['pim', 'product information', 'inventory extensions', 'ai suggestions', 'podcasts'] * @relatedEndpoints ['items', 'nexus', 'orders'] * @commonPatterns ['Manage inventory extensions', 'Generate AI descriptions', 'Handle podcast content'] * * @example * ```typescript * const api = new AugurAPI({ bearerToken: 'your-jwt', siteId: 'your-site' }); * * // Health check * const health = await api.p21Pim.healthCheck.get(); * * // List inventory extensions * const extensions = await api.p21Pim.invMastExt.list({ limit: 20 }); * * // Get specific extension * const extension = await api.p21Pim.invMastExt.get(12345); * * // Generate AI suggestions * const displaySuggestions = await api.p21Pim.items.suggestDisplayDesc.get(12345); * const webSuggestions = await api.p21Pim.items.suggestWebDesc.get(12345); * * // Manage podcasts * const podcasts = await api.p21Pim.podcasts.list(); * const podcast = await api.p21Pim.podcasts.get(789); * ``` */ export declare class P21PimClient extends BaseServiceClient { /** Health check resource */ readonly healthCheck: HealthCheckResource; /** Health check data resource (data-only) */ readonly healthCheckData: HealthCheckDataResource; /** Inventory master extensions resource */ readonly invMastExt: InvMastExtResource; /** Inventory master extensions data resource (data-only) */ readonly invMastExtData: InvMastExtDataResource; /** AI-powered item services resource */ readonly items: ItemsResource; /** AI-powered item services data resource (data-only) */ readonly itemsData: ItemsDataResource; /** Podcast management resource */ readonly podcasts: PodcastsResource; /** Podcast management data resource (data-only) */ readonly podcastsData: PodcastsDataResource; constructor(http: HTTPClient, baseUrl?: string); protected getServiceDescription(): string; } //# sourceMappingURL=client.d.ts.map