@arrowsphere/api-client 3.17.0 → 3.18.0-rc.1

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.18.0] - 2023-01-10
+
+### Changed
+
+- Add endpoint cart
+
 ## [3.17.0] - 2022-12-05
 
 ### Changed

package/build/abstractClient.d.ts

@@ -140,6 +140,15 @@ export declare abstract class AbstractClient {
      * @returns Promise\<T\>
      */
     protected patch<T>(payload?: Payload, parameters?: Parameters, headers?: Headers, options?: Options): Promise<T>;
+    /**
+     * Sends a DELETE request
+     * @param payload - Payload to be sent in the POST body
+     * @param parameters - Query parameters to be sent in the request
+     * @param headers - Headers to be sent in the request
+     * @param options - Options to send
+     * @returns Promise\<T\>
+     */
+    protected delete(parameters?: Parameters, headers?: Headers, options?: Options): Promise<void>;
     /**
      * Generates the full url for request
      * @param parameters - Parameters to serialize

package/build/abstractClient.js

@@ -195,6 +195,20 @@ class AbstractClient {
         });
         return this.getResponse(response);
     }
+    /**
+     * Sends a DELETE request
+     * @param payload - Payload to be sent in the POST body
+     * @param parameters - Query parameters to be sent in the request
+     * @param headers - Headers to be sent in the request
+     * @param options - Options to send
+     * @returns Promise\<T\>
+     */
+    async delete(parameters = {}, headers = {}, options = {}) {
+        const response = await this.client.delete(this.generateUrl(parameters, options), {
+            headers: this.prepareHeaders(headers),
+        });
+        return this.getResponse(response);
+    }
     /**
      * Generates the full url for request
      * @param parameters - Parameters to serialize

package/build/cart/cartClient.d.ts

@@ -0,0 +1,33 @@
+import { AbstractClient, Parameters } from '../abstractClient';
+import { GetResult } from '../getResult';
+import { Item, ItemList } from './entities';
+export declare enum ItemRequestFields {
+    ADDITIONAL_DATA = "additionalData",
+    OFFER_NAME = "offerName",
+    PRICE_BAND_ARROWSPHERE_SKU = "priceBandArrowsphereSku",
+    QUANTITY = "quantity"
+}
+export declare enum ItemAdditionalDataRequestFields {
+    NAME = "name",
+    VALUE = "value"
+}
+export declare type ItemAdditionalDataRequestType = {
+    [ItemAdditionalDataRequestFields.NAME]: string;
+    [ItemAdditionalDataRequestFields.VALUE]: string;
+};
+export declare type ItemRequestType = {
+    [ItemRequestFields.ADDITIONAL_DATA]?: ItemAdditionalDataRequestType[];
+    [ItemRequestFields.OFFER_NAME]: string;
+    [ItemRequestFields.PRICE_BAND_ARROWSPHERE_SKU]: string;
+    [ItemRequestFields.QUANTITY]: number;
+};
+export declare type ItemAddRequestType = ItemRequestType;
+export declare type ItemUpdateRequestType = ItemRequestType;
+export declare class CartClient extends AbstractClient {
+    protected basePath: string;
+    addItem(postData: ItemAddRequestType, parameters?: Parameters): Promise<GetResult<Item>>;
+    updateItem(itemId: string, postData: ItemUpdateRequestType, parameters?: Parameters): Promise<GetResult<Item>>;
+    removeItem(itemId: string, parameters?: Parameters): Promise<void>;
+    removeItems(parameters?: Parameters): Promise<void>;
+    listItems(perPage?: number, page?: number, parameters?: Parameters): Promise<GetResult<ItemList>>;
+}

package/build/cart/cartClient.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CartClient = exports.ItemAdditionalDataRequestFields = exports.ItemRequestFields = void 0;
+const abstractClient_1 = require("../abstractClient");
+const getResult_1 = require("../getResult");
+const entities_1 = require("./entities");
+var ItemRequestFields;
+(function (ItemRequestFields) {
+    ItemRequestFields["ADDITIONAL_DATA"] = "additionalData";
+    ItemRequestFields["OFFER_NAME"] = "offerName";
+    ItemRequestFields["PRICE_BAND_ARROWSPHERE_SKU"] = "priceBandArrowsphereSku";
+    ItemRequestFields["QUANTITY"] = "quantity";
+})(ItemRequestFields = exports.ItemRequestFields || (exports.ItemRequestFields = {}));
+var ItemAdditionalDataRequestFields;
+(function (ItemAdditionalDataRequestFields) {
+    ItemAdditionalDataRequestFields["NAME"] = "name";
+    ItemAdditionalDataRequestFields["VALUE"] = "value";
+})(ItemAdditionalDataRequestFields = exports.ItemAdditionalDataRequestFields || (exports.ItemAdditionalDataRequestFields = {}));
+class CartClient extends abstractClient_1.AbstractClient {
+    constructor() {
+        super(...arguments);
+        this.basePath = '/cart';
+    }
+    async addItem(postData, parameters = {}) {
+        return new getResult_1.GetResult(entities_1.Item, await this.post(postData, parameters));
+    }
+    async updateItem(itemId, postData, parameters = {}) {
+        this.path = `/${itemId}`;
+        return new getResult_1.GetResult(entities_1.Item, await this.patch(postData, parameters));
+    }
+    async removeItem(itemId, parameters = {}) {
+        this.path = `/${itemId}`;
+        return this.delete(parameters);
+    }
+    async removeItems(parameters = {}) {
+        return this.delete(parameters);
+    }
+    async listItems(perPage = 25, page = 1, parameters = {}) {
+        this.setPerPage(perPage);
+        this.setPage(page);
+        return new getResult_1.GetResult(entities_1.ItemList, await this.get(parameters));
+    }
+}
+exports.CartClient = CartClient;
+//# sourceMappingURL=cartClient.js.map

package/build/cart/entities/index.d.ts

@@ -0,0 +1,2 @@
+export * from './item';
+export * from './itemList';

package/build/cart/entities/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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("./item"), exports);
+__exportStar(require("./itemList"), exports);
+//# sourceMappingURL=index.js.map

package/build/cart/entities/item.d.ts

@@ -0,0 +1,33 @@
+import { AbstractEntity } from '../../abstractEntity';
+export declare enum ItemAdditionalDataFields {
+    NAME = "name",
+    VALUE = "value"
+}
+export declare type ItemAdditionalDataType = {
+    [ItemAdditionalDataFields.NAME]: string;
+    [ItemAdditionalDataFields.VALUE]: string;
+};
+export declare enum ItemFields {
+    ITEM_ID = "itemId",
+    ADDITIONAL_DATA = "additionalData",
+    OFFER_NAME = "offerName",
+    PRICE_BAND_ARROWSPHERE_SKU = "priceBandArrowsphereSku",
+    QUANTITY = "quantity"
+}
+export declare type ItemType = {
+    [ItemFields.ADDITIONAL_DATA]?: ItemAdditionalDataType[] | undefined;
+    [ItemFields.ITEM_ID]: string;
+    [ItemFields.OFFER_NAME]: string;
+    [ItemFields.PRICE_BAND_ARROWSPHERE_SKU]: string;
+    [ItemFields.QUANTITY]: number;
+};
+export declare class Item extends AbstractEntity<ItemType> {
+    #private;
+    constructor(itemResponse: ItemType);
+    get itemId(): string;
+    get additionalData(): ItemAdditionalDataType[] | undefined;
+    get offerName(): string;
+    get priceBandArrowsphereSku(): string;
+    get quantity(): number;
+    toJSON(): ItemType;
+}

package/build/cart/entities/item.js

@@ -0,0 +1,73 @@
+"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 _additionalData, _itemId, _offerName, _priceBandArrowsphereSku, _quantity;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Item = exports.ItemFields = exports.ItemAdditionalDataFields = void 0;
+const abstractEntity_1 = require("../../abstractEntity");
+var ItemAdditionalDataFields;
+(function (ItemAdditionalDataFields) {
+    ItemAdditionalDataFields["NAME"] = "name";
+    ItemAdditionalDataFields["VALUE"] = "value";
+})(ItemAdditionalDataFields = exports.ItemAdditionalDataFields || (exports.ItemAdditionalDataFields = {}));
+var ItemFields;
+(function (ItemFields) {
+    ItemFields["ITEM_ID"] = "itemId";
+    ItemFields["ADDITIONAL_DATA"] = "additionalData";
+    ItemFields["OFFER_NAME"] = "offerName";
+    ItemFields["PRICE_BAND_ARROWSPHERE_SKU"] = "priceBandArrowsphereSku";
+    ItemFields["QUANTITY"] = "quantity";
+})(ItemFields = exports.ItemFields || (exports.ItemFields = {}));
+class Item extends abstractEntity_1.AbstractEntity {
+    constructor(itemResponse) {
+        super(itemResponse);
+        _additionalData.set(this, void 0);
+        _itemId.set(this, void 0);
+        _offerName.set(this, void 0);
+        _priceBandArrowsphereSku.set(this, void 0);
+        _quantity.set(this, void 0);
+        __classPrivateFieldSet(this, _additionalData, itemResponse[ItemFields.ADDITIONAL_DATA]);
+        __classPrivateFieldSet(this, _itemId, itemResponse[ItemFields.ITEM_ID]);
+        __classPrivateFieldSet(this, _offerName, itemResponse[ItemFields.OFFER_NAME]);
+        __classPrivateFieldSet(this, _priceBandArrowsphereSku, itemResponse[ItemFields.PRICE_BAND_ARROWSPHERE_SKU]);
+        __classPrivateFieldSet(this, _quantity, itemResponse[ItemFields.QUANTITY]);
+    }
+    get itemId() {
+        return __classPrivateFieldGet(this, _itemId);
+    }
+    get additionalData() {
+        return __classPrivateFieldGet(this, _additionalData);
+    }
+    get offerName() {
+        return __classPrivateFieldGet(this, _offerName);
+    }
+    get priceBandArrowsphereSku() {
+        return __classPrivateFieldGet(this, _priceBandArrowsphereSku);
+    }
+    get quantity() {
+        return __classPrivateFieldGet(this, _quantity);
+    }
+    toJSON() {
+        return {
+            [ItemFields.ADDITIONAL_DATA]: this.additionalData,
+            [ItemFields.ITEM_ID]: this.itemId,
+            [ItemFields.OFFER_NAME]: this.offerName,
+            [ItemFields.PRICE_BAND_ARROWSPHERE_SKU]: this.priceBandArrowsphereSku,
+            [ItemFields.QUANTITY]: this.quantity,
+        };
+    }
+}
+exports.Item = Item;
+_additionalData = new WeakMap(), _itemId = new WeakMap(), _offerName = new WeakMap(), _priceBandArrowsphereSku = new WeakMap(), _quantity = new WeakMap();
+//# sourceMappingURL=item.js.map

package/build/cart/entities/itemList.d.ts

@@ -0,0 +1,9 @@
+import { AbstractEntity } from '../../abstractEntity';
+import { Item, ItemType } from './item';
+export declare type ItemListType = Array<ItemType>;
+export declare class ItemList extends AbstractEntity<ItemListType> {
+    #private;
+    constructor(itemListResponse: ItemListType);
+    get items(): Item[];
+    toJSON(): ItemType[];
+}

package/build/cart/entities/itemList.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 _items;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemList = void 0;
+const abstractEntity_1 = require("../../abstractEntity");
+const item_1 = require("./item");
+class ItemList extends abstractEntity_1.AbstractEntity {
+    constructor(itemListResponse) {
+        super(itemListResponse);
+        _items.set(this, void 0);
+        __classPrivateFieldSet(this, _items, itemListResponse.map((item) => new item_1.Item(item)));
+    }
+    get items() {
+        return __classPrivateFieldGet(this, _items);
+    }
+    toJSON() {
+        return this.items.map((item) => item.toJSON());
+    }
+}
+exports.ItemList = ItemList;
+_items = new WeakMap();
+//# sourceMappingURL=itemList.js.map

package/build/cart/index.d.ts

@@ -0,0 +1,2 @@
+export * from './entities';
+export * from './cartClient';

package/build/cart/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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("./entities"), exports);
+__exportStar(require("./cartClient"), exports);
+//# sourceMappingURL=index.js.map

package/build/index.d.ts

@@ -3,6 +3,7 @@ export * from './abstractClient';
 export * from './abstractEntity';
 export * from './abstractGraphQLClient';
 export * from './campaign/';
+export * from './cart/';
 export * from './catalog/';
 export * from './consumption';
 export * from './customers/';

package/build/index.js

@@ -28,6 +28,7 @@ __exportStar(require("./abstractClient"), exports);
 __exportStar(require("./abstractEntity"), exports);
 __exportStar(require("./abstractGraphQLClient"), exports);
 __exportStar(require("./campaign/"), exports);
+__exportStar(require("./cart/"), exports);
 __exportStar(require("./catalog/"), exports);
 __exportStar(require("./consumption"), exports);
 __exportStar(require("./customers/"), exports);

package/build/publicApiClient.d.ts

@@ -9,6 +9,7 @@ import { CampaignClient } from './campaign';
 import { ConsumptionClient } from './consumption';
 import { StandardsClient } from './security/standards/standardsClient';
 import { RegisterClient } from './security';
+import { CartClient } from './cart/cartClient';
 /**
  * Public API Client class, should be the main entry point for your calls
  */
@@ -57,5 +58,6 @@ export declare class PublicApiClient extends AbstractClient {
     getConsumptionClient(): ConsumptionClient;
     getSecurityStandardsClient(): StandardsClient;
     getSecurityRegisterClient(): RegisterClient;
+    getCartClient(): CartClient;
 }
 export default PublicApiClient;

package/build/publicApiClient.js

@@ -12,6 +12,7 @@ const campaign_1 = require("./campaign");
 const consumption_1 = require("./consumption");
 const standardsClient_1 = require("./security/standards/standardsClient");
 const security_1 = require("./security");
+const cartClient_1 = require("./cart/cartClient");
 /**
  * Public API Client class, should be the main entry point for your calls
  */
@@ -117,6 +118,12 @@ class PublicApiClient extends abstractClient_1.AbstractClient {
             .setApiKey(this.apiKey)
             .setHeaders(this.headers);
     }
+    getCartClient() {
+        return new cartClient_1.CartClient()
+            .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.17.0",
+  "version": "3.18.0-rc.1",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",