@arrowsphere/api-client 3.416.0 → 3.417.0

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.417.0] - 2026.10.30
+### Added
+- [catalog] Add `checkEligibility` endpoint to `CatalogClient` (`CheckEligibilityPayload`, `CheckEligibilityItems`, `CheckEligibilityItem`)
+
 ## [3.416.0] - 2026.10.30
 ### Added
 - [licenses] Add `CUSTOMER_ERP_ID` to `CompanyDetailKeyEnum`

package/build/catalog/catalogClient.d.ts

@@ -2,6 +2,8 @@ import { AbstractRestfulClient, Parameters } from '../abstractRestfulClient';
 import { GetResult } from '../getResult';
 import { Program } from './entities/program';
 import { Programs } from './entities/programs';
+import { CheckEligibilityItems } from './entities/checkEligibilityItems';
+import { CheckEligibilityPayload } from './types/checkEligibility';
 export declare class CatalogClient extends AbstractRestfulClient {
     /**
      * The base path of the API
@@ -9,4 +11,8 @@ export declare class CatalogClient extends AbstractRestfulClient {
     protected basePath: string;
     listPrograms(category: string, parameters?: Parameters): Promise<GetResult<Programs>>;
     getProgram(category: string, program: string, parameters?: Parameters): Promise<GetResult<Program>>;
+    /**
+     * Checks the Microsoft growth margin eligibility of quote items for an end customer, and resolves their prices
+     */
+    checkEligibility(payload: CheckEligibilityPayload, parameters?: Parameters): Promise<GetResult<CheckEligibilityItems>>;
 }

package/build/catalog/catalogClient.js

@@ -5,6 +5,7 @@ const abstractRestfulClient_1 = require("../abstractRestfulClient");
 const getResult_1 = require("../getResult");
 const program_1 = require("./entities/program");
 const programs_1 = require("./entities/programs");
+const checkEligibilityItems_1 = require("./entities/checkEligibilityItems");
 class CatalogClient extends abstractRestfulClient_1.AbstractRestfulClient {
     constructor() {
         super(...arguments);
@@ -21,6 +22,13 @@ class CatalogClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.path = `/categories/${category}/programs/${program}`;
         return new getResult_1.GetResult(program_1.Program, await this.get(parameters));
     }
+    /**
+     * Checks the Microsoft growth margin eligibility of quote items for an end customer, and resolves their prices
+     */
+    async checkEligibility(payload, parameters = {}) {
+        this.path = '/check-eligibility';
+        return new getResult_1.GetResult(checkEligibilityItems_1.CheckEligibilityItems, await this.post(payload, parameters));
+    }
 }
 exports.CatalogClient = CatalogClient;
 //# sourceMappingURL=catalogClient.js.map

package/build/catalog/entities/checkEligibilityItem.d.ts

@@ -0,0 +1,48 @@
+import { AbstractEntity } from '../../abstractEntity';
+export declare enum CheckEligibilityItemFields {
+    GROWTH_MARGIN = "growthMargin",
+    IS_ELIGIBLE = "isEligible",
+    PRICEBAND_ARROWSPHERE_SKU = "pricebandArrowsphereSku",
+    PRICES = "prices",
+    PRICES_WITHOUT_PROMOTION = "pricesWithoutPromotion",
+    PRICING_RULES = "pricingRules",
+    QUANTITY = "quantity"
+}
+export declare type CheckEligibilityPricesType = {
+    arrow?: number;
+    endCustomer?: number;
+    partner?: number;
+    retail?: number;
+};
+export declare type CheckEligibilityPricingRuleType = {
+    rateType?: string;
+    tier?: number;
+    type?: string;
+    value?: number;
+};
+export declare type CheckEligibilityGrowthMarginType = {
+    discountType?: string;
+    growthMarginId?: string;
+    incrementalMarginRate?: number;
+};
+export declare type CheckEligibilityItemType = {
+    [CheckEligibilityItemFields.GROWTH_MARGIN]?: CheckEligibilityGrowthMarginType;
+    [CheckEligibilityItemFields.IS_ELIGIBLE]: boolean;
+    [CheckEligibilityItemFields.PRICEBAND_ARROWSPHERE_SKU]: string;
+    [CheckEligibilityItemFields.PRICES]?: CheckEligibilityPricesType;
+    [CheckEligibilityItemFields.PRICES_WITHOUT_PROMOTION]?: CheckEligibilityPricesType;
+    [CheckEligibilityItemFields.PRICING_RULES]?: CheckEligibilityPricingRuleType[];
+    [CheckEligibilityItemFields.QUANTITY]: number;
+};
+export declare class CheckEligibilityItem extends AbstractEntity<CheckEligibilityItemType> {
+    #private;
+    constructor(input: CheckEligibilityItemType);
+    get growthMargin(): CheckEligibilityGrowthMarginType | undefined;
+    get isEligible(): boolean;
+    get pricebandArrowsphereSku(): string;
+    get prices(): CheckEligibilityPricesType | undefined;
+    get pricesWithoutPromotion(): CheckEligibilityPricesType | undefined;
+    get pricingRules(): CheckEligibilityPricingRuleType[] | undefined;
+    get quantity(): number;
+    toJSON(): CheckEligibilityItemType;
+}

package/build/catalog/entities/checkEligibilityItem.js

@@ -0,0 +1,82 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _CheckEligibilityItem_growthMargin, _CheckEligibilityItem_isEligible, _CheckEligibilityItem_pricebandArrowsphereSku, _CheckEligibilityItem_prices, _CheckEligibilityItem_pricesWithoutPromotion, _CheckEligibilityItem_pricingRules, _CheckEligibilityItem_quantity;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckEligibilityItem = exports.CheckEligibilityItemFields = void 0;
+const abstractEntity_1 = require("../../abstractEntity");
+var CheckEligibilityItemFields;
+(function (CheckEligibilityItemFields) {
+    CheckEligibilityItemFields["GROWTH_MARGIN"] = "growthMargin";
+    CheckEligibilityItemFields["IS_ELIGIBLE"] = "isEligible";
+    CheckEligibilityItemFields["PRICEBAND_ARROWSPHERE_SKU"] = "pricebandArrowsphereSku";
+    CheckEligibilityItemFields["PRICES"] = "prices";
+    CheckEligibilityItemFields["PRICES_WITHOUT_PROMOTION"] = "pricesWithoutPromotion";
+    CheckEligibilityItemFields["PRICING_RULES"] = "pricingRules";
+    CheckEligibilityItemFields["QUANTITY"] = "quantity";
+})(CheckEligibilityItemFields = exports.CheckEligibilityItemFields || (exports.CheckEligibilityItemFields = {}));
+class CheckEligibilityItem extends abstractEntity_1.AbstractEntity {
+    constructor(input) {
+        super(input);
+        _CheckEligibilityItem_growthMargin.set(this, void 0);
+        _CheckEligibilityItem_isEligible.set(this, void 0);
+        _CheckEligibilityItem_pricebandArrowsphereSku.set(this, void 0);
+        _CheckEligibilityItem_prices.set(this, void 0);
+        _CheckEligibilityItem_pricesWithoutPromotion.set(this, void 0);
+        _CheckEligibilityItem_pricingRules.set(this, void 0);
+        _CheckEligibilityItem_quantity.set(this, void 0);
+        __classPrivateFieldSet(this, _CheckEligibilityItem_growthMargin, input[CheckEligibilityItemFields.GROWTH_MARGIN], "f");
+        __classPrivateFieldSet(this, _CheckEligibilityItem_isEligible, input[CheckEligibilityItemFields.IS_ELIGIBLE], "f");
+        __classPrivateFieldSet(this, _CheckEligibilityItem_pricebandArrowsphereSku, input[CheckEligibilityItemFields.PRICEBAND_ARROWSPHERE_SKU], "f");
+        __classPrivateFieldSet(this, _CheckEligibilityItem_prices, input[CheckEligibilityItemFields.PRICES], "f");
+        __classPrivateFieldSet(this, _CheckEligibilityItem_pricesWithoutPromotion, input[CheckEligibilityItemFields.PRICES_WITHOUT_PROMOTION], "f");
+        __classPrivateFieldSet(this, _CheckEligibilityItem_pricingRules, input[CheckEligibilityItemFields.PRICING_RULES], "f");
+        __classPrivateFieldSet(this, _CheckEligibilityItem_quantity, input[CheckEligibilityItemFields.QUANTITY], "f");
+    }
+    get growthMargin() {
+        return __classPrivateFieldGet(this, _CheckEligibilityItem_growthMargin, "f");
+    }
+    get isEligible() {
+        return __classPrivateFieldGet(this, _CheckEligibilityItem_isEligible, "f");
+    }
+    get pricebandArrowsphereSku() {
+        return __classPrivateFieldGet(this, _CheckEligibilityItem_pricebandArrowsphereSku, "f");
+    }
+    get prices() {
+        return __classPrivateFieldGet(this, _CheckEligibilityItem_prices, "f");
+    }
+    get pricesWithoutPromotion() {
+        return __classPrivateFieldGet(this, _CheckEligibilityItem_pricesWithoutPromotion, "f");
+    }
+    get pricingRules() {
+        return __classPrivateFieldGet(this, _CheckEligibilityItem_pricingRules, "f");
+    }
+    get quantity() {
+        return __classPrivateFieldGet(this, _CheckEligibilityItem_quantity, "f");
+    }
+    toJSON() {
+        return {
+            [CheckEligibilityItemFields.GROWTH_MARGIN]: this.growthMargin,
+            [CheckEligibilityItemFields.IS_ELIGIBLE]: this.isEligible,
+            [CheckEligibilityItemFields.PRICEBAND_ARROWSPHERE_SKU]: this
+                .pricebandArrowsphereSku,
+            [CheckEligibilityItemFields.PRICES]: this.prices,
+            [CheckEligibilityItemFields.PRICES_WITHOUT_PROMOTION]: this
+                .pricesWithoutPromotion,
+            [CheckEligibilityItemFields.PRICING_RULES]: this.pricingRules,
+            [CheckEligibilityItemFields.QUANTITY]: this.quantity,
+        };
+    }
+}
+exports.CheckEligibilityItem = CheckEligibilityItem;
+_CheckEligibilityItem_growthMargin = new WeakMap(), _CheckEligibilityItem_isEligible = new WeakMap(), _CheckEligibilityItem_pricebandArrowsphereSku = new WeakMap(), _CheckEligibilityItem_prices = new WeakMap(), _CheckEligibilityItem_pricesWithoutPromotion = new WeakMap(), _CheckEligibilityItem_pricingRules = new WeakMap(), _CheckEligibilityItem_quantity = new WeakMap();
+//# sourceMappingURL=checkEligibilityItem.js.map

package/build/catalog/entities/checkEligibilityItems.d.ts

@@ -0,0 +1,9 @@
+import { AbstractEntity } from '../../abstractEntity';
+import { CheckEligibilityItem, CheckEligibilityItemType } from './checkEligibilityItem';
+export declare type CheckEligibilityItemsType = Array<CheckEligibilityItemType>;
+export declare class CheckEligibilityItems extends AbstractEntity<CheckEligibilityItemsType> {
+    #private;
+    constructor(input: CheckEligibilityItemsType);
+    get list(): CheckEligibilityItem[];
+    toJSON(): CheckEligibilityItemsType;
+}

package/build/catalog/entities/checkEligibilityItems.js

@@ -0,0 +1,33 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _CheckEligibilityItems_list;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckEligibilityItems = void 0;
+const abstractEntity_1 = require("../../abstractEntity");
+const checkEligibilityItem_1 = require("./checkEligibilityItem");
+class CheckEligibilityItems extends abstractEntity_1.AbstractEntity {
+    constructor(input) {
+        super(input);
+        _CheckEligibilityItems_list.set(this, void 0);
+        __classPrivateFieldSet(this, _CheckEligibilityItems_list, input.map((item) => new checkEligibilityItem_1.CheckEligibilityItem(item)), "f");
+    }
+    get list() {
+        return __classPrivateFieldGet(this, _CheckEligibilityItems_list, "f");
+    }
+    toJSON() {
+        return this.list.map((item) => item.toJSON());
+    }
+}
+exports.CheckEligibilityItems = CheckEligibilityItems;
+_CheckEligibilityItems_list = new WeakMap();
+//# sourceMappingURL=checkEligibilityItems.js.map

package/build/catalog/index.d.ts

@@ -2,8 +2,11 @@ export * from './catalogGraphQLClient';
 export * from './catalogClient';
 export * from './catalogPlanClient';
 export * from './types/catalogPlan';
+export * from './types/checkEligibility';
 export * from './types/catalogGraphQLTypes';
 export * from './entities/program';
 export * from './entities/programs';
+export * from './entities/checkEligibilityItem';
+export * from './entities/checkEligibilityItems';
 export * from './types/catalogGraphQLQueries';
 export * from './types/catalogGraphQLSchemas';

package/build/catalog/index.js

@@ -18,9 +18,12 @@ __exportStar(require("./catalogGraphQLClient"), exports);
 __exportStar(require("./catalogClient"), exports);
 __exportStar(require("./catalogPlanClient"), exports);
 __exportStar(require("./types/catalogPlan"), exports);
+__exportStar(require("./types/checkEligibility"), exports);
 __exportStar(require("./types/catalogGraphQLTypes"), exports);
 __exportStar(require("./entities/program"), exports);
 __exportStar(require("./entities/programs"), exports);
+__exportStar(require("./entities/checkEligibilityItem"), exports);
+__exportStar(require("./entities/checkEligibilityItems"), exports);
 __exportStar(require("./types/catalogGraphQLQueries"), exports);
 __exportStar(require("./types/catalogGraphQLSchemas"), exports);
 //# sourceMappingURL=index.js.map

package/build/catalog/types/checkEligibility.d.ts

@@ -0,0 +1,10 @@
+export declare type CheckEligibilityItemPayload = {
+    pricebandArrowsphereSku: string;
+    quantity: number;
+    vendorProgram: string;
+};
+export declare type CheckEligibilityPayload = {
+    customerReference: string;
+    items: CheckEligibilityItemPayload[];
+    resellerReference: string;
+};

package/build/catalog/types/checkEligibility.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=checkEligibility.js.map

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "3.416.0",
+  "version": "3.417.0",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",