@arrowsphere/api-client 3.408.0 → 3.409.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.409.0] - 2026.10.07
+### Added
+- [catalog] Add `CatalogPlanClient` (`/catalog/plans`): list, get, create, update and delete catalog plans
+
 ## [3.408.0] - 2026.10.02
 ### Added
 - [Orders] provide partner's acronym on Order

package/build/catalog/catalogPlanClient.d.ts

@@ -0,0 +1,32 @@
+import { AbstractRestfulClient, Parameters } from '../abstractRestfulClient';
+import { CreateCatalogPlanPayload, CreateCatalogPlanResponse, GetCatalogPlanResponse, ListCatalogPlansResponse, UpdateCatalogPlanPayload } from './types/catalogPlan';
+export declare class CatalogPlanClient extends AbstractRestfulClient {
+    /**
+     * The base path of the API
+     */
+    protected basePath: string;
+    /**
+     * Lists the catalog plans of the logged-in reseller
+     */
+    listCatalogPlans(parameters?: Parameters): Promise<ListCatalogPlansResponse>;
+    /**
+     * Gets a single catalog plan by name
+     */
+    getCatalogPlan(planName: string, parameters?: Parameters): Promise<GetCatalogPlanResponse>;
+    /**
+     * Creates a new catalog plan
+     */
+    createCatalogPlan(payload: CreateCatalogPlanPayload, parameters?: Parameters): Promise<CreateCatalogPlanResponse>;
+    /**
+     * Partially updates a catalog plan (name, customersRef and/or programs)
+     */
+    updateCatalogPlan(planName: string, payload: UpdateCatalogPlanPayload, parameters?: Parameters): Promise<void>;
+    /**
+     * Deletes a catalog plan
+     */
+    deleteCatalogPlan(planName: string, parameters?: Parameters): Promise<void>;
+    /**
+     * Plan names may contain spaces, so they must be encoded in the URL path
+     */
+    private planPath;
+}

package/build/catalog/catalogPlanClient.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogPlanClient = void 0;
+const abstractRestfulClient_1 = require("../abstractRestfulClient");
+class CatalogPlanClient extends abstractRestfulClient_1.AbstractRestfulClient {
+    constructor() {
+        super(...arguments);
+        /**
+         * The base path of the API
+         */
+        this.basePath = '/catalog/plans';
+    }
+    /**
+     * Lists the catalog plans of the logged-in reseller
+     */
+    async listCatalogPlans(parameters = {}) {
+        this.path = '';
+        return this.get(parameters, {}, { returnAxiosData: true });
+    }
+    /**
+     * Gets a single catalog plan by name
+     */
+    async getCatalogPlan(planName, parameters = {}) {
+        this.path = this.planPath(planName);
+        return this.get(parameters, {}, { returnAxiosData: true });
+    }
+    /**
+     * Creates a new catalog plan
+     */
+    async createCatalogPlan(payload, parameters = {}) {
+        this.path = '';
+        return this.post(payload, parameters, {}, { returnAxiosData: true });
+    }
+    /**
+     * Partially updates a catalog plan (name, customersRef and/or programs)
+     */
+    async updateCatalogPlan(planName, payload, parameters = {}) {
+        this.path = this.planPath(planName);
+        return this.patch(payload, parameters, {}, { returnAxiosData: true });
+    }
+    /**
+     * Deletes a catalog plan
+     */
+    async deleteCatalogPlan(planName, parameters = {}) {
+        this.path = this.planPath(planName);
+        return this.delete(parameters);
+    }
+    /**
+     * Plan names may contain spaces, so they must be encoded in the URL path
+     */
+    planPath(planName) {
+        return `/${encodeURIComponent(planName)}`;
+    }
+}
+exports.CatalogPlanClient = CatalogPlanClient;
+//# sourceMappingURL=catalogPlanClient.js.map

package/build/catalog/index.d.ts

@@ -1,5 +1,7 @@
 export * from './catalogGraphQLClient';
 export * from './catalogClient';
+export * from './catalogPlanClient';
+export * from './types/catalogPlan';
 export * from './types/catalogGraphQLTypes';
 export * from './entities/program';
 export * from './entities/programs';

package/build/catalog/index.js

@@ -16,6 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./catalogGraphQLClient"), exports);
 __exportStar(require("./catalogClient"), exports);
+__exportStar(require("./catalogPlanClient"), exports);
+__exportStar(require("./types/catalogPlan"), exports);
 __exportStar(require("./types/catalogGraphQLTypes"), exports);
 __exportStar(require("./entities/program"), exports);
 __exportStar(require("./entities/programs"), exports);

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

@@ -0,0 +1,50 @@
+import { PaginationData } from '../../pagination';
+export declare type CatalogPlanBillingLabel = {
+    label: string;
+    value: number;
+};
+export declare type CatalogPlanProgramRulesType = {
+    cycles?: CatalogPlanBillingLabel[];
+    marketSegments?: string[];
+    terms?: CatalogPlanBillingLabel[];
+};
+export declare type CatalogPlanProgramType = {
+    offerSku?: string[];
+    programName: string;
+    rules?: CatalogPlanProgramRulesType;
+};
+export declare type CatalogPlanType = {
+    customersRef: string[];
+    name: string;
+    offers: string[];
+    programs: CatalogPlanProgramType[];
+};
+export declare type CatalogPlanProgramRulesPayload = {
+    cycles?: number[];
+    marketSegments?: string[];
+    terms?: number[];
+};
+export declare type CatalogPlanProgramPayload = {
+    offerSku?: string[];
+    programName: string;
+    rules?: CatalogPlanProgramRulesPayload;
+};
+export declare type CreateCatalogPlanPayload = {
+    customersRef?: string[];
+    name: string;
+    programs?: CatalogPlanProgramPayload[];
+};
+export declare type UpdateCatalogPlanPayload = Partial<CreateCatalogPlanPayload>;
+export declare type ListCatalogPlansResponse = {
+    data: CatalogPlanType[];
+    pagination: PaginationData;
+    status: number;
+};
+export declare type GetCatalogPlanResponse = {
+    data: CatalogPlanType;
+    status: number;
+};
+export declare type CreateCatalogPlanResponse = {
+    data: CatalogPlanType;
+    status: number;
+};

package/build/catalog/types/catalogPlan.js

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

package/build/publicApiClient.d.ts

@@ -10,7 +10,7 @@ import { ConsumptionClient } from './consumption';
 import { WellArchitectedRegisterClient, WellArchitectedStandardsClient } from './wellArchitected';
 import { CartClient } from './cart/cartClient';
 import { SupportCenterClient } from './supportCenter';
-import { CatalogClient } from './catalog';
+import { CatalogClient, CatalogPlanClient } from './catalog';
 import { UserClient } from './user';
 import { NotificationsClient } from './notifications';
 import { RegisterClient, StandardsClient } from './security';
@@ -104,6 +104,7 @@ export declare class PublicApiClient extends AbstractRestfulClient {
     getCartClient(configuration?: ConfigurationsClient): CartClient;
     getSupportCenterClient(configuration?: ConfigurationsClient): SupportCenterClient;
     getCatalogClient(configuration?: ConfigurationsClient): CatalogClient;
+    getCatalogPlanClient(configuration?: ConfigurationsClient): CatalogPlanClient;
     getUserClient(configuration?: ConfigurationsClient): UserClient;
     getNotificationsClient(configuration?: ConfigurationsClient): NotificationsClient;
     getOrganizationUnitClient(configuration?: ConfigurationsClient): OrganizationUnitClient;

package/build/publicApiClient.js

@@ -196,6 +196,11 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.applyConfig(client);
         return client;
     }
+    getCatalogPlanClient(configuration) {
+        const client = new catalog_1.CatalogPlanClient(configuration);
+        this.applyConfig(client);
+        return client;
+    }
     getUserClient(configuration) {
         const client = new user_1.UserClient(configuration);
         this.applyConfig(client);

package/package.json

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