@arrowsphere/api-client 3.27.0 → 3.28.0-rc.ckh.2

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.28.0] - 2023-05-22
+
+### Changed
+
+- Add catalog programs endpoints
+
 ## [3.27.0] - 2023-05-10
 
 - update create order client to add attributes for injection scenario

package/build/catalog/catalogClient.d.ts

@@ -0,0 +1,12 @@
+import { AbstractClient, Parameters } from '../abstractClient';
+import { GetResult } from '../getResult';
+import { Program } from './entities/program';
+import { Programs } from './entities/programs';
+export declare class CatalogClient extends AbstractClient {
+    /**
+     * The base path of the API
+     */
+    protected basePath: string;
+    listPrograms(category: string, parameters?: Parameters): Promise<GetResult<Programs>>;
+    getProgram(category: string, program: string, parameters?: Parameters): Promise<GetResult<Program>>;
+}

package/build/catalog/catalogClient.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogClient = void 0;
+const abstractClient_1 = require("../abstractClient");
+const getResult_1 = require("../getResult");
+const program_1 = require("./entities/program");
+const programs_1 = require("./entities/programs");
+class CatalogClient extends abstractClient_1.AbstractClient {
+    constructor() {
+        super(...arguments);
+        /**
+         * The base path of the API
+         */
+        this.basePath = '/catalog';
+    }
+    async listPrograms(category, parameters = {}) {
+        this.path = `/categories/${category}/programs`;
+        return new getResult_1.GetResult(programs_1.Programs, await this.get(parameters));
+    }
+    async getProgram(category, program, parameters = {}) {
+        this.path = `/categories/${category}/programs/${program}`;
+        return new getResult_1.GetResult(program_1.Program, await this.get(parameters));
+    }
+}
+exports.CatalogClient = CatalogClient;
+//# sourceMappingURL=catalogClient.js.map

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

@@ -0,0 +1,66 @@
+import { AbstractEntity } from '../../abstractEntity';
+export declare enum ProgramFields {
+    REFERENCE = "reference",
+    NAME = "name",
+    ASSOCIATED_SUBSCRIPTION_PROGRAM = "associatedSubscriptionProgram",
+    LOGO = "logo",
+    CATEGORY = "category",
+    LINKS = "links",
+    EXTRA_INFORMATION = "extraInformation"
+}
+export declare enum ProgramLinksFields {
+    PROGRAM = "program",
+    PRODUCTS = "products"
+}
+export declare enum ProgramExtraInfoFields {
+    RESELLER = "reseller",
+    END_CUSTOMER = "endCustomer",
+    ORDER = "order"
+}
+export declare enum ProgramExtraInfoItemFields {
+    NAME = "name",
+    LABEL = "label",
+    TYPE = "type",
+    REGEX = "regex",
+    MANDATORY = "mandatory"
+}
+export declare type ProgramType = {
+    [ProgramFields.REFERENCE]?: string;
+    [ProgramFields.NAME]: string;
+    [ProgramFields.ASSOCIATED_SUBSCRIPTION_PROGRAM]: string;
+    [ProgramFields.LOGO]: string;
+    [ProgramFields.CATEGORY]: string;
+    [ProgramFields.LINKS]: ProgramLinksType;
+    [ProgramFields.EXTRA_INFORMATION]: ExtraInfoType;
+};
+export declare type ProgramLinksType = {
+    [ProgramLinksFields.PROGRAM]: string;
+    [ProgramLinksFields.PRODUCTS]: string;
+};
+export declare type ExtraInfoType = {
+    [ProgramExtraInfoFields.RESELLER]: ExtraInfoItemType[];
+    [ProgramExtraInfoFields.END_CUSTOMER]: ExtraInfoItemType[];
+    [ProgramExtraInfoFields.ORDER]: ExtraInfoItemType[];
+};
+export declare type ExtraInfoItemType = {
+    [ProgramExtraInfoItemFields.NAME]: string;
+    [ProgramExtraInfoItemFields.LABEL]: string;
+    [ProgramExtraInfoItemFields.TYPE]: string;
+    [ProgramExtraInfoItemFields.REGEX]: string;
+    [ProgramExtraInfoItemFields.MANDATORY]: boolean;
+};
+export declare class Program extends AbstractEntity<ProgramType> {
+    #private;
+    constructor(input: ProgramType);
+    get reference(): string | undefined;
+    get name(): string;
+    get associatedSubscriptionProgram(): string;
+    get logo(): string;
+    get category(): string;
+    get links(): {
+        program: string;
+        products: string;
+    };
+    get extraInformation(): ExtraInfoType;
+    toJSON(): ProgramType;
+}

package/build/catalog/entities/program.js

@@ -0,0 +1,102 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _reference, _name, _associatedSubscriptionProgram, _logo, _category, _links, _extraInformation;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Program = exports.ProgramExtraInfoItemFields = exports.ProgramExtraInfoFields = exports.ProgramLinksFields = exports.ProgramFields = void 0;
+const abstractEntity_1 = require("../../abstractEntity");
+var ProgramFields;
+(function (ProgramFields) {
+    ProgramFields["REFERENCE"] = "reference";
+    ProgramFields["NAME"] = "name";
+    ProgramFields["ASSOCIATED_SUBSCRIPTION_PROGRAM"] = "associatedSubscriptionProgram";
+    ProgramFields["LOGO"] = "logo";
+    ProgramFields["CATEGORY"] = "category";
+    ProgramFields["LINKS"] = "links";
+    ProgramFields["EXTRA_INFORMATION"] = "extraInformation";
+})(ProgramFields = exports.ProgramFields || (exports.ProgramFields = {}));
+var ProgramLinksFields;
+(function (ProgramLinksFields) {
+    ProgramLinksFields["PROGRAM"] = "program";
+    ProgramLinksFields["PRODUCTS"] = "products";
+})(ProgramLinksFields = exports.ProgramLinksFields || (exports.ProgramLinksFields = {}));
+var ProgramExtraInfoFields;
+(function (ProgramExtraInfoFields) {
+    ProgramExtraInfoFields["RESELLER"] = "reseller";
+    ProgramExtraInfoFields["END_CUSTOMER"] = "endCustomer";
+    ProgramExtraInfoFields["ORDER"] = "order";
+})(ProgramExtraInfoFields = exports.ProgramExtraInfoFields || (exports.ProgramExtraInfoFields = {}));
+var ProgramExtraInfoItemFields;
+(function (ProgramExtraInfoItemFields) {
+    ProgramExtraInfoItemFields["NAME"] = "name";
+    ProgramExtraInfoItemFields["LABEL"] = "label";
+    ProgramExtraInfoItemFields["TYPE"] = "type";
+    ProgramExtraInfoItemFields["REGEX"] = "regex";
+    ProgramExtraInfoItemFields["MANDATORY"] = "mandatory";
+})(ProgramExtraInfoItemFields = exports.ProgramExtraInfoItemFields || (exports.ProgramExtraInfoItemFields = {}));
+class Program extends abstractEntity_1.AbstractEntity {
+    constructor(input) {
+        super(input);
+        _reference.set(this, void 0);
+        _name.set(this, void 0);
+        _associatedSubscriptionProgram.set(this, void 0);
+        _logo.set(this, void 0);
+        _category.set(this, void 0);
+        _links.set(this, void 0);
+        _extraInformation.set(this, void 0);
+        __classPrivateFieldSet(this, _reference, input[ProgramFields.REFERENCE]);
+        __classPrivateFieldSet(this, _name, input[ProgramFields.NAME]);
+        __classPrivateFieldSet(this, _associatedSubscriptionProgram, input[ProgramFields.ASSOCIATED_SUBSCRIPTION_PROGRAM]);
+        __classPrivateFieldSet(this, _logo, input[ProgramFields.LOGO]);
+        __classPrivateFieldSet(this, _category, input[ProgramFields.CATEGORY]);
+        __classPrivateFieldSet(this, _links, input[ProgramFields.LINKS]);
+        __classPrivateFieldSet(this, _extraInformation, input[ProgramFields.EXTRA_INFORMATION]);
+    }
+    get reference() {
+        return __classPrivateFieldGet(this, _reference);
+    }
+    get name() {
+        return __classPrivateFieldGet(this, _name);
+    }
+    get associatedSubscriptionProgram() {
+        return __classPrivateFieldGet(this, _associatedSubscriptionProgram);
+    }
+    get logo() {
+        return __classPrivateFieldGet(this, _logo);
+    }
+    get category() {
+        return __classPrivateFieldGet(this, _category);
+    }
+    get links() {
+        return __classPrivateFieldGet(this, _links);
+    }
+    get extraInformation() {
+        return __classPrivateFieldGet(this, _extraInformation);
+    }
+    toJSON() {
+        return {
+            [ProgramFields.REFERENCE]: this.reference,
+            [ProgramFields.NAME]: this.name,
+            [ProgramFields.ASSOCIATED_SUBSCRIPTION_PROGRAM]: this
+                .associatedSubscriptionProgram,
+            [ProgramFields.LOGO]: this.logo,
+            [ProgramFields.CATEGORY]: this.category,
+            [ProgramFields.LINKS]: this.links,
+            [ProgramFields.EXTRA_INFORMATION]: this.extraInformation,
+        };
+    }
+}
+exports.Program = Program;
+_reference = new WeakMap(), _name = new WeakMap(), _associatedSubscriptionProgram = new WeakMap(), _logo = new WeakMap(), _category = new WeakMap(), _links = new WeakMap(), _extraInformation = new WeakMap();
+//# sourceMappingURL=program.js.map

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

@@ -0,0 +1,9 @@
+import { AbstractEntity } from '../../abstractEntity';
+import { Program, ProgramType } from './program';
+export declare type ProgramsType = Array<ProgramType>;
+export declare class Programs extends AbstractEntity<ProgramsType> {
+    #private;
+    constructor(input: ProgramsType);
+    get list(): Program[];
+    toJSON(): ProgramsType;
+}

package/build/catalog/entities/programs.js

@@ -0,0 +1,35 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _list;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Programs = void 0;
+const abstractEntity_1 = require("../../abstractEntity");
+const program_1 = require("./program");
+class Programs extends abstractEntity_1.AbstractEntity {
+    constructor(input) {
+        super(input);
+        _list.set(this, void 0);
+        __classPrivateFieldSet(this, _list, input.map((input) => new program_1.Program(input)));
+    }
+    get list() {
+        return __classPrivateFieldGet(this, _list);
+    }
+    toJSON() {
+        return this.list.map((item) => item.toJSON());
+    }
+}
+exports.Programs = Programs;
+_list = new WeakMap();
+//# sourceMappingURL=programs.js.map

package/build/catalog/index.d.ts

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

package/build/catalog/index.js

@@ -11,5 +11,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("./types/catalogGraphQLTypes"), exports);
+__exportStar(require("./entities/program"), exports);
+__exportStar(require("./entities/programs"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -55,7 +55,7 @@ export declare type ProductType = {
     xspUrl?: string;
     saleConstraints?: SaleConstraintsType;
     vendor?: VendorType;
-    program?: ProgramType;
+    program?: GraphqlProgramType;
     weightTopSales?: number;
     weightForced?: number;
     priceBand?: Array<PriceBandType>;
@@ -130,7 +130,7 @@ export declare type SaleConstraintsType = {
 export declare type VendorType = {
     name?: string;
 };
-export declare type ProgramType = {
+export declare type GraphqlProgramType = {
     isEnabled?: boolean;
     legacyCode?: string;
     names?: ProgramNameType;

package/build/publicApiClient.d.ts

@@ -11,6 +11,7 @@ import { StandardsClient } from './security/standards/standardsClient';
 import { RegisterClient } from './security';
 import { CartClient } from './cart/cartClient';
 import { SupportCenterClient } from './supportCenter';
+import { CatalogClient } from './catalog';
 /**
  * Public API Client class, should be the main entry point for your calls
  */
@@ -61,5 +62,6 @@ export declare class PublicApiClient extends AbstractClient {
     getSecurityRegisterClient(): RegisterClient;
     getCartClient(): CartClient;
     getSupportCenterClient(): SupportCenterClient;
+    getCatalogClient(): CatalogClient;
 }
 export default PublicApiClient;

package/build/publicApiClient.js

@@ -14,6 +14,7 @@ const standardsClient_1 = require("./security/standards/standardsClient");
 const security_1 = require("./security");
 const cartClient_1 = require("./cart/cartClient");
 const supportCenter_1 = require("./supportCenter");
+const catalog_1 = require("./catalog");
 /**
  * Public API Client class, should be the main entry point for your calls
  */
@@ -131,6 +132,12 @@ class PublicApiClient extends abstractClient_1.AbstractClient {
             .setApiKey(this.apiKey)
             .setHeaders(this.headers);
     }
+    getCatalogClient() {
+        return new catalog_1.CatalogClient()
+            .setUrl(this.url)
+            .setApiKey(this.apiKey)
+            .setHeaders(this.headers);
+    }
 }
 exports.PublicApiClient = PublicApiClient;
 exports.default = PublicApiClient;

package/package.json

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