@reactionary/hcl 0.9.12 → 0.9.14

package/src/schema/hcl.schema.d.ts

@@ -234,7 +234,7 @@ export interface HclProductResponse extends HclProductSearchItem {
     components?: HclProductResponse[];
     /** Quantity — only present on components array elements */
     quantity?: string;
-    merchandisingAssociations?: HclProductResponse[];
+    merchandisingAssociations?: HclAssociation[];
     attachments?: HclAttachment[];
     images?: HclImage[];
     /**
@@ -694,3 +694,279 @@ export interface HclWcsOrderHistoryResponse {
     recordSetStartNumber?: string;
     recordSetComplete?: string;
 }
+/**
+ * A product item returned within a `merchandisingAssociations` array on a
+ * HCL detail-profile product response. Extends the search item shape with
+ * an `associationCodeType` that identifies the semantic relationship.
+ *
+ * Known values: 'ACCESSORY', 'SPAREPART', 'REPLACEMENT', 'CROSSSELL', 'UPSELL', 'UPGRADE'
+ */
+export interface HclAssociation extends HclProductSearchItem {
+    /** The association type code. e.g. 'ACCESSORY', 'SPAREPART', 'REPLACEMENT'. */
+    associationCodeType?: string;
+    /** Display sequence for ordering associations within a type. */
+    associationSequence?: string;
+}
+/**
+ * A single activity data entry within a marketing spot response.
+ * When `baseMarketingSpotDataType` is 'CatalogEntry' or 'CatalogEntryId',
+ * the entry represents a product recommendation from the spot.
+ */
+export interface HclEspotActivityData {
+    /** 'CatalogEntry' | 'CatalogEntryId' | 'CatalogGroupId' | 'MarketingContent' */
+    baseMarketingSpotDataType?: string;
+    /** Internal HCL product uniqueID (numeric string). Present for CatalogEntry/CatalogEntryId types. */
+    contentId?: string;
+    /** Part number of the product, if returned inline by the spot configuration. */
+    partNumber?: string;
+    /** Display name of the product or content entry. */
+    contentName?: string;
+}
+/** A single marketing spot entry in a WCS espot response. */
+export interface HclEspotMarketingSpot {
+    eSpotName?: string;
+    baseMarketingSpotActivityData?: HclEspotActivityData[];
+}
+/** Top-level response from GET /wcs/resources/store/{storeId}/espot/{name}. */
+export interface HclEspotResponse {
+    MarketingSpotData?: HclEspotMarketingSpot[];
+}
+/** A single customer segment (member group) entry in a WCS segment response. */
+export interface HclSegmentMemberGroup {
+    id: string;
+    displayName?: {
+        language: number;
+        value: string;
+    };
+    description?: {
+        language: number;
+        value: string;
+    };
+    usage?: string[];
+}
+/** Top-level response from GET /wcs/resources/store/{storeId}/segment. */
+export interface HclSegmentResponse {
+    MemberGroup?: HclSegmentMemberGroup[];
+    recordSetTotal?: number;
+    recordSetCount?: number;
+    recordSetStartNumber?: number;
+    recordSetComplete?: boolean;
+}
+/**
+ * A WCS person contact embedded within an organization's contactInfo or addressBook.
+ * Shares the same shape as HclWcsPersonContact but is returned under different keys
+ * in the organization API response.
+ */
+export interface HclWcsOrgContact {
+    nickName?: string;
+    firstName?: string;
+    lastName?: string;
+    /** Street address lines. Index 0 = street, index 1 = second line. */
+    addressLine?: string[];
+    city?: string;
+    stateOrProvinceName?: string;
+    zipCode?: string;
+    country?: string;
+    phone1?: string;
+    email1?: string;
+    /** '1' marks this as the default / primary shipping address. */
+    primary?: string;
+    addressType?: string;
+    addressId?: string;
+}
+/**
+ * An organization entry as returned by GET /wcs/resources/store/{storeId}/organization/{id}.
+ * Fields present depend on the profileName used (IBM_Org_Entity_Details vs IBM_Organization_Details).
+ */
+export interface HclOrganizationItem {
+    /** Internal WCS organization/member ID (numeric string). */
+    organizationId?: string;
+    orgEntityId?: string;
+    organizationName?: string;
+    displayName?: string;
+    /** Approval status code: '0' = pending, '1' = approved, '2' = rejected. */
+    status?: string;
+    /** '0' = locked/blocked, '1' = active. */
+    state?: string;
+    /** Tax payer ID (maps to taxIdentifier on the domain model). */
+    taxPayerId?: string;
+    /** Legal entity identifier. */
+    legalId?: string;
+    /** Business category. */
+    businessCategory?: string;
+    description?: string;
+    /** Primary billing / contact address. */
+    contactInfo?: HclWcsOrgContact;
+    /** Additional shipping addresses. */
+    addressBook?: HclWcsOrgContact[];
+    /** Context attributes set by IBM_Org_Entity_Details profile (key-value map). */
+    contextAttribute?: Record<string, unknown>;
+    /** Parent organization member ID. */
+    parentMemberId?: string;
+}
+/**
+ * Top-level response from GET /wcs/resources/store/{storeId}/organization
+ * with profileName=IBM_Organization_List_Summary.
+ */
+export interface HclOrganizationListResponse {
+    organizationDataBeans?: HclOrganizationItem[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+    recordSetComplete?: string;
+}
+/**
+ * Response from POST /wcs/resources/store/{storeId}/organization/buyer.
+ * Returns the newly created org entity ID and the buyer admin user ID.
+ */
+export interface HclBuyerRegistrationResponse {
+    orgEntityId: string;
+    userId: string;
+    resourceName?: string;
+}
+/** A single store attribute as returned in the storelocator response. */
+export interface HclStoreAttribute {
+    name: string;
+    value: string;
+    displayName?: string;
+    displayValue?: string;
+}
+/** A description block for a physical store. */
+export interface HclStoreDescription {
+    displayStoreName?: string;
+}
+/**
+ * A single physical store entry as returned by the WCS storelocator endpoints.
+ * Reference: location_based_services.yaml — storelocator-storelocator_item
+ */
+export interface HclPhysicalStore {
+    uniqueID: string;
+    /** Store name as configured in WCS (fallback when Description[].displayStoreName is absent). */
+    storeName?: string;
+    /** Array of description blocks; index 0 typically contains displayStoreName. */
+    Description?: HclStoreDescription[];
+    /** Street address lines. Index 0 = primary line, index 1 = second line. */
+    addressLine?: string[];
+    city?: string;
+    stateOrProvinceName?: string;
+    postalCode?: string;
+    country?: string;
+    telephone1?: string;
+    email?: string;
+    /** Geographic latitude (as a string — coerce with Number()). */
+    latitude?: string;
+    /** Geographic longitude (as a string — coerce with Number()). */
+    longitude?: string;
+    /** Distance from the query point (as a string — coerce with Number()). */
+    distance?: string;
+    Attribute?: HclStoreAttribute[];
+    userDataField?: {
+        value?: string;
+        key: string;
+    }[];
+}
+/**
+ * Top-level response from GET /wcs/resources/store/{storeId}/storelocator/latitude/{lat}/longitude/{lon}.
+ */
+export interface HclStoreLocatorResponse {
+    PhysicalStore?: HclPhysicalStore[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+    recordSetComplete?: string;
+}
+/**
+ * A single item entry within a wishlist — from GET /wishlist/{id}/item.
+ */
+export interface HclWishlistItem {
+    /** Unique identifier for the wishlist item entry. */
+    giftListItemID?: string;
+    /** Internal WCS catalog entry ID (numeric string). Corresponds to a SKU. */
+    productId?: string;
+    /** SKU part number — use this as the variant identifier when present. */
+    partNumber?: string;
+    /** Requested quantity as a string — coerce with Number(). */
+    quantityRequested?: string;
+    /** Purchased quantity as a string. */
+    quantityBought?: string;
+    location?: string;
+}
+/**
+ * A single wishlist (GiftList) entry as returned by GET /wishlist/@self.
+ */
+export interface HclWishlist {
+    /** Internal WCS list ID. */
+    uniqueID?: string;
+    /** Customer-assigned external identifier. Alias for uniqueID on some responses. */
+    externalIdentifier?: string;
+    /** The list's display name. */
+    descriptionName?: string;
+    /** The list's optional description text. */
+    description?: string;
+    lastUpdate?: string;
+    guestAccessKey?: string;
+    /** Items embedded in the list (present when fetching a specific list with items). */
+    item?: HclWishlistItem[];
+}
+/** Top-level response from GET /wcs/resources/store/{storeId}/wishlist/@self. */
+export interface HclWishlistListResponse {
+    GiftList?: HclWishlist[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+    recordSetComplete?: string;
+}
+/** Top-level response from GET /wcs/resources/store/{storeId}/wishlist/{id}/item. */
+export interface HclWishlistItemResponse {
+    GiftList?: HclWishlist[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+}
+/** Response from POST /wishlist (create) and PUT /wishlist/{id} (update). */
+export interface HclWishlistMutationResponse {
+    uniqueID?: string;
+    externalIdentifier?: string;
+    resourceName?: string;
+}
+/** A single item in a WCS requisition list. */
+export interface HclRequisitionListItem {
+    /** Unique identifier of the item within the list. */
+    requisitionListItemId?: string;
+    /** Numeric product identifier (same semantics as GiftList item.productId). */
+    productId?: string;
+    /** Partner number / SKU. */
+    partNumber?: string;
+    /** Requested quantity as a string. */
+    quantity?: string;
+    /** Location (e.g. "online"). */
+    location?: string;
+}
+/** A single WCS requisition list (from GET /requisitionList/@self or by ID). */
+export interface HclRequisitionList {
+    /** Unique identifier of the list. */
+    requisitionListId?: string;
+    /** Display name of the list. */
+    name?: string;
+    /** Description of the list. */
+    description?: string;
+    /** Items in the list (only present on detail endpoints). */
+    item?: HclRequisitionListItem[];
+}
+/** Response from GET /requisitionList/@self — array of lists. */
+export interface HclRequisitionListResponse {
+    resultList?: HclRequisitionList[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+}
+/** Response from GET /requisitionList/{id}/item. */
+export interface HclRequisitionListDetailResponse {
+    resultList?: HclRequisitionList[];
+    recordSetTotal?: string;
+}
+/** Response from POST /requisitionList (create) and PUT /requisitionList/{id}. */
+export interface HclRequisitionListMutationResponse {
+    requisitionListId?: string;
+    resourceName?: string;
+}

package/src/test/test-utils.d.ts

@@ -4,6 +4,7 @@ export declare function getHclTestConfiguration(): HclConfiguration;
 export declare function createHclClient(contextOverrides?: Partial<RequestContext>): Omit<import("@reactionary/core").Client, "product" | "productSearch" | "category"> & Omit<import("@reactionary/core").ClientFromCapabilities<{
     product?: true | undefined;
     productSearch?: true | undefined;
+    company?: false | undefined;
     price?: false | undefined;
     order?: false | undefined;
     cart?: false | undefined;
@@ -12,8 +13,10 @@ export declare function createHclClient(contextOverrides?: Partial<RequestContex
     profile?: false | undefined;
     inventory?: false | undefined;
     category?: true | undefined;
+    store?: false | undefined;
+    productList?: false | undefined;
     orderSearch?: false | undefined;
-}>, "product" | "productSearch" | "price" | "order" | "cart" | "checkout" | "identity" | "profile" | "inventory" | "category" | "orderSearch"> & {
+}>, "product" | "productSearch" | "company" | "price" | "order" | "cart" | "checkout" | "identity" | "profile" | "inventory" | "category" | "store" | "productList" | "orderSearch"> & {
     product: import("../index.js").HclProductCapability<import("../index.js").HclProductFactory<import("zod").ZodObject<{
         identifier: import("zod").ZodObject<{
             key: import("zod").ZodString;