@arrowsphere/api-client 3.373.0 → 3.374.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.374.0] - 2026.06.05
+### Added
+- [billing] Add PricingPlan client with support for CRUD operations, business rules, scopes, and history
+
 ## [3.373.0] - 2026.06.03
 ### Added
 - [graphql-api] Add new field to ProductType: `isForPartnerOnly`

package/build/billing/index.d.ts

@@ -1,2 +1,4 @@
 export * from './entities/export/exportAsyncRequest';
 export * from './billingClient';
+export * from './pricingPlanClient';
+export * from './types';

package/build/billing/index.js

@@ -16,4 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./entities/export/exportAsyncRequest"), exports);
 __exportStar(require("./billingClient"), exports);
+__exportStar(require("./pricingPlanClient"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/build/billing/pricingPlanClient.d.ts

@@ -0,0 +1,56 @@
+import { AbstractRestfulClient } from '../abstractRestfulClient';
+import { AttachScopesPayload, AttachScopesResponse, CreateBusinessRulesPayload, CreateBusinessRulesResponse, CreatePricingPlanPayload, CreatePricingPlanResponse, DetachScopesPayload, GetBusinessRulesHistoryParameters, GetBusinessRulesHistoryResponse, GetBusinessRulesParameters, GetBusinessRulesResponse, GetClientsHistoryParameters, GetClientsHistoryResponse, GetPricingPlanResponse, GetScopesParameters, GetScopesResponse, ListPricingPlansParameters, ListPricingPlansResponse, PricingPlanScopeType, UpdatePricingPlanPayload } from './types/pricingPlan';
+export declare class PricingPlanClient extends AbstractRestfulClient {
+    /**
+     * The base path of the API
+     */
+    protected basePath: string;
+    /**
+     * Lists pricing plans with optional filters
+     */
+    listPricingPlans(params?: ListPricingPlansParameters): Promise<ListPricingPlansResponse>;
+    /**
+     * Gets a single pricing plan by reference
+     */
+    getPricingPlan(reference: string): Promise<GetPricingPlanResponse>;
+    /**
+     * Creates a new pricing plan
+     */
+    createPricingPlan(payload: CreatePricingPlanPayload): Promise<CreatePricingPlanResponse>;
+    /**
+     * Updates a pricing plan (rename)
+     */
+    updatePricingPlan(reference: string, payload: UpdatePricingPlanPayload): Promise<void>;
+    /**
+     * Deletes a pricing plan
+     */
+    deletePricingPlan(reference: string): Promise<void>;
+    /**
+     * Gets business rules for a pricing plan
+     */
+    getBusinessRules(reference: string, params?: GetBusinessRulesParameters): Promise<GetBusinessRulesResponse>;
+    /**
+     * Creates or updates business rules for a pricing plan
+     */
+    createBusinessRules(reference: string, payload: CreateBusinessRulesPayload): Promise<CreateBusinessRulesResponse>;
+    /**
+     * Gets business rules history for a pricing plan
+     */
+    getBusinessRulesHistory(reference: string, params: GetBusinessRulesHistoryParameters): Promise<GetBusinessRulesHistoryResponse>;
+    /**
+     * Gets scopes (attached customers or resellers) for a pricing plan
+     */
+    getScopes(reference: string, type: PricingPlanScopeType, params?: GetScopesParameters): Promise<GetScopesResponse>;
+    /**
+     * Attaches scopes (customers or resellers) to a pricing plan
+     */
+    attachScopes(reference: string, type: PricingPlanScopeType, payload: AttachScopesPayload): Promise<AttachScopesResponse>;
+    /**
+     * Detaches scopes (customers or resellers) from a pricing plan
+     */
+    detachScopes(reference: string, type: PricingPlanScopeType, payload: DetachScopesPayload): Promise<void>;
+    /**
+     * Gets clients (attach/detach) history for a pricing plan
+     */
+    getClientsHistory(reference: string, params?: GetClientsHistoryParameters): Promise<GetClientsHistoryResponse>;
+}

package/build/billing/pricingPlanClient.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingPlanClient = void 0;
+const abstractRestfulClient_1 = require("../abstractRestfulClient");
+class PricingPlanClient extends abstractRestfulClient_1.AbstractRestfulClient {
+    constructor() {
+        super(...arguments);
+        /**
+         * The base path of the API
+         */
+        this.basePath = '/billing/pricing-plans';
+    }
+    /**
+     * Lists pricing plans with optional filters
+     */
+    async listPricingPlans(params) {
+        this.path = '';
+        return this.get(params, {}, { returnAxiosData: true });
+    }
+    /**
+     * Gets a single pricing plan by reference
+     */
+    async getPricingPlan(reference) {
+        this.path = `/${reference}`;
+        return this.get({}, {}, { returnAxiosData: true });
+    }
+    /**
+     * Creates a new pricing plan
+     */
+    async createPricingPlan(payload) {
+        this.path = '';
+        return this.post(payload, {}, {}, { returnAxiosData: true });
+    }
+    /**
+     * Updates a pricing plan (rename)
+     */
+    async updatePricingPlan(reference, payload) {
+        this.path = `/${reference}`;
+        return this.patch(payload, {}, {}, { returnAxiosData: true });
+    }
+    /**
+     * Deletes a pricing plan
+     */
+    async deletePricingPlan(reference) {
+        this.path = `/${reference}`;
+        return this.delete();
+    }
+    /**
+     * Gets business rules for a pricing plan
+     */
+    async getBusinessRules(reference, params) {
+        this.path = `/${reference}/business-rules`;
+        return this.get(params, {}, { returnAxiosData: true });
+    }
+    /**
+     * Creates or updates business rules for a pricing plan
+     */
+    async createBusinessRules(reference, payload) {
+        this.path = `/${reference}/business-rules`;
+        return this.post(payload, {}, {}, { returnAxiosData: true });
+    }
+    /**
+     * Gets business rules history for a pricing plan
+     */
+    async getBusinessRulesHistory(reference, params) {
+        this.path = `/${reference}/business-rules/history`;
+        return this.get(params, {}, { returnAxiosData: true });
+    }
+    /**
+     * Gets scopes (attached customers or resellers) for a pricing plan
+     */
+    async getScopes(reference, type, params) {
+        this.path = `/${reference}/scopes/${type}`;
+        return this.get(params, {}, { returnAxiosData: true });
+    }
+    /**
+     * Attaches scopes (customers or resellers) to a pricing plan
+     */
+    async attachScopes(reference, type, payload) {
+        this.path = `/${reference}/scopes/${type}`;
+        return this.post(payload, {}, {}, { returnAxiosData: true });
+    }
+    /**
+     * Detaches scopes (customers or resellers) from a pricing plan
+     */
+    async detachScopes(reference, type, payload) {
+        this.path = `/${reference}/scopes/${type}`;
+        return this.delete({}, {}, {}, payload);
+    }
+    /**
+     * Gets clients (attach/detach) history for a pricing plan
+     */
+    async getClientsHistory(reference, params) {
+        this.path = `/${reference}/history`;
+        return this.get(params, {}, { returnAxiosData: true });
+    }
+}
+exports.PricingPlanClient = PricingPlanClient;
+//# sourceMappingURL=pricingPlanClient.js.map

package/build/billing/types/index.d.ts

@@ -0,0 +1 @@
+export * from './pricingPlan';

package/build/billing/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pricingPlan"), exports);
+//# sourceMappingURL=index.js.map

package/build/billing/types/pricingPlan.d.ts

@@ -0,0 +1,189 @@
+export declare enum PricingPlanScopeType {
+    END_CUSTOMER_XSP_REF = "end-customer-xsp-ref",
+    RESELLER_XSP_REF = "reseller-xsp-ref"
+}
+export declare enum BusinessRuleEffectType {
+    RATE = "rate",
+    LINK_TO_DEFAULT = "linkToDefault"
+}
+export declare type PricingPlanScopeData = {
+    marketplace: string;
+    program: string;
+};
+export declare type PricingPlanType = {
+    effectiveDate: string;
+    name: string;
+    reference: string;
+    scope: PricingPlanScopeData;
+};
+export declare type BusinessRuleScopeData = {
+    billingCycle?: number;
+    billingTerm?: number;
+    classification?: string;
+    default?: boolean;
+    marketSegment?: string;
+    offerArrowSphereSku?: string;
+    offerFamily?: string;
+    priceBandArrowSphereSku?: string;
+};
+export declare type BusinessRuleEffectData = {
+    rateType?: string;
+    type: BusinessRuleEffectType;
+    value?: number;
+};
+export declare type BusinessRuleType = {
+    effect: BusinessRuleEffectData;
+    effectiveDate?: string;
+    label?: string;
+    metadata?: {
+        updatedAt: string;
+    };
+    reference?: string;
+    scope: BusinessRuleScopeData;
+};
+export declare type ListPricingPlansParameters = {
+    continuationToken?: string;
+    endCustomerXspRef?: string;
+    marketplace?: string;
+    perPage?: number;
+    program?: string;
+};
+export declare type CreatePricingPlanPayload = {
+    name: string;
+    scope: {
+        marketplace?: string;
+        program: string;
+    };
+};
+export declare type UpdatePricingPlanPayload = {
+    name: string;
+};
+export declare type GetBusinessRulesParameters = {
+    continuationToken?: string;
+    offerFamily?: string;
+    perPage?: number;
+};
+export declare type CreateBusinessRulesPayload = {
+    businessRules: BusinessRuleType[];
+};
+export declare type GetBusinessRulesHistoryParameters = {
+    billingCycle?: string;
+    billingTerm?: string;
+    classification: string;
+    effectiveDateFrom?: string;
+    effectiveDateTo?: string;
+    marketSegment?: string;
+    offerArrowSphereSku?: string;
+    offerFamily?: string;
+    priceBandArrowSphereSku?: string;
+};
+export declare type GetScopesParameters = {
+    continuationToken?: string;
+    perPage?: number;
+};
+export declare type AttachScopesPayload = {
+    scopes: string[];
+};
+export declare type DetachScopesPayload = {
+    scopes: string[];
+};
+export declare type GetClientsHistoryParameters = {
+    continuationToken?: string;
+    perPage?: number;
+};
+export declare type ContinuationPagination = {
+    continuationToken: string;
+    next?: string;
+    perPage: number;
+    previous?: string;
+};
+export declare type ListPricingPlansResponse = {
+    data: {
+        pricingPlans: PricingPlanType[];
+    };
+    pagination: ContinuationPagination;
+    status: number;
+};
+export declare type GetPricingPlanResponse = {
+    data: {
+        pricingPlan: PricingPlanType;
+    };
+    status: number;
+};
+export declare type CreatePricingPlanResponse = {
+    data: {
+        pricingPlan: PricingPlanType;
+    };
+    status: number;
+};
+export declare type GetBusinessRulesResponse = {
+    data: {
+        businessRules: BusinessRuleType[];
+    };
+    pagination: ContinuationPagination;
+    status: number;
+};
+export declare type CreateBusinessRulesResponse = {
+    data: {
+        businessRules: BusinessRuleType[];
+    };
+    status: number;
+};
+export declare type BusinessRulesHistoryEntry = {
+    effect: BusinessRuleEffectData & {
+        tier: number;
+    };
+    effectiveDate: string;
+    label: string;
+    metadata: {
+        updatedAt: string;
+        updatedBy: {
+            contactName: string;
+            xapUsername: string;
+        };
+    };
+    reference: string;
+    scope: BusinessRuleScopeData;
+};
+export declare type GetBusinessRulesHistoryResponse = {
+    data: {
+        businessRules: BusinessRulesHistoryEntry[];
+    };
+    pagination: ContinuationPagination;
+    status: number;
+};
+export declare type GetScopesResponse = {
+    data: {
+        scopes: string[];
+    };
+    pagination?: ContinuationPagination;
+    status: number;
+};
+export declare type AttachScopesResponse = {
+    data: {
+        errors?: {
+            conflictWithExistingPricingPlan?: Record<string, string>;
+        };
+        scopes: string[];
+    };
+    status: number;
+};
+export declare type ClientsHistoryAction = {
+    action: string;
+    company: {
+        name: string;
+        xspRef: string;
+    };
+    effectiveDate: string;
+    updatedBy: {
+        contactName: string;
+        xapUsername: string;
+    };
+};
+export declare type GetClientsHistoryResponse = {
+    data: {
+        actions: ClientsHistoryAction[];
+    };
+    pagination: ContinuationPagination;
+    status: number;
+};

package/build/billing/types/pricingPlan.js

@@ -0,0 +1,15 @@
+"use strict";
+// --- Enums ---
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BusinessRuleEffectType = exports.PricingPlanScopeType = void 0;
+var PricingPlanScopeType;
+(function (PricingPlanScopeType) {
+    PricingPlanScopeType["END_CUSTOMER_XSP_REF"] = "end-customer-xsp-ref";
+    PricingPlanScopeType["RESELLER_XSP_REF"] = "reseller-xsp-ref";
+})(PricingPlanScopeType = exports.PricingPlanScopeType || (exports.PricingPlanScopeType = {}));
+var BusinessRuleEffectType;
+(function (BusinessRuleEffectType) {
+    BusinessRuleEffectType["RATE"] = "rate";
+    BusinessRuleEffectType["LINK_TO_DEFAULT"] = "linkToDefault";
+})(BusinessRuleEffectType = exports.BusinessRuleEffectType || (exports.BusinessRuleEffectType = {}));
+//# sourceMappingURL=pricingPlan.js.map

package/build/publicApiClient.d.ts

@@ -17,7 +17,7 @@ import { RegisterClient, StandardsClient } from './security';
 import { PartnerClient } from './partner';
 import { OrganizationUnitClient } from './organisationUnit';
 import { QuotesClient } from './quotes';
-import { BillingClient } from './billing';
+import { BillingClient, PricingPlanClient } from './billing';
 import { AnalyticsClient } from './analytics';
 import { ReportsClient } from './reports';
 import { OrderSoftwareClient } from './orderSoftware';
@@ -108,6 +108,7 @@ export declare class PublicApiClient extends AbstractRestfulClient {
     getNotificationsClient(configuration?: ConfigurationsClient): NotificationsClient;
     getOrganizationUnitClient(configuration?: ConfigurationsClient): OrganizationUnitClient;
     getBillingClient(configuration?: ConfigurationsClient): BillingClient;
+    getPricingPlanClient(configuration?: ConfigurationsClient): PricingPlanClient;
     getAnalyticsClient(configuration?: ConfigurationsClient): AnalyticsClient;
     getReportsClient(configuration?: ConfigurationsClient): ReportsClient;
     getMonitoringClient(configuration?: ConfigurationsClient): MonitoringClient;

package/build/publicApiClient.js

@@ -216,6 +216,11 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.applyConfig(client);
         return client;
     }
+    getPricingPlanClient(configuration) {
+        const client = new billing_1.PricingPlanClient(configuration);
+        this.applyConfig(client);
+        return client;
+    }
     getAnalyticsClient(configuration) {
         const client = new analytics_1.AnalyticsClient(configuration);
         this.applyConfig(client);

package/package.json

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