@arrowsphere/api-client 3.11.0 → 3.13.0-rc.1

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 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.13.0] - 2022-08-25
+
+### Changed
+
+- add endpoint campaign email for landing page campaign
+
+## [3.12.0] - 2022-08-22
+
+### Changed
+
+- refactor: import file and constant
+
 ## [3.11.0] - 2022-08-02
 
 ### Changed

package/build/campaign/campaignClient.d.ts

@@ -2,6 +2,12 @@ import { AbstractClient, Parameters } from '../abstractClient';
 import { GetResult } from '../getResult';
 import { Campaign } from './entities/campaign/campaign';
 import { CampaignAssets } from './entities/campaignAssets/campaignAssets';
+export declare type POST_EMAIL_CAMPAIGN = {
+    application: string;
+    metadata: {
+        [keys in string]: string;
+    };
+};
 export declare class CampaignClient extends AbstractClient {
     /**
      * The base path of the API
@@ -10,4 +16,5 @@ export declare class CampaignClient extends AbstractClient {
     getActiveCampaign(parameters?: Parameters): Promise<GetResult<Campaign>>;
     getCampaignAssets(campaignReference: string, parameters?: Parameters): Promise<GetResult<CampaignAssets>>;
     getCampaignDetails(campaignReference: string, parameters?: Parameters): Promise<GetResult<Campaign>>;
+    postCampaignEmail(campaignReference: string, postData: POST_EMAIL_CAMPAIGN, parameters?: Parameters): Promise<void>;
 }

package/build/campaign/campaignClient.js

@@ -25,6 +25,10 @@ class CampaignClient extends abstractClient_1.AbstractClient {
         this.path = `/${campaignReference}`;
         return new getResult_1.GetResult(campaign_1.Campaign, await this.get(parameters));
     }
+    async postCampaignEmail(campaignReference, postData, parameters = {}) {
+        this.path = `/${campaignReference}/notify`;
+        return await this.post(postData, parameters);
+    }
 }
 exports.CampaignClient = CampaignClient;
 //# sourceMappingURL=campaignClient.js.map

package/build/catalog/catalogGraphQLClient.d.ts

@@ -1,10 +1,6 @@
 import { AbstractGraphQLClient } from '../abstractGraphQLClient';
 import { GetProductsType } from './types/catalogGraphQLTypes';
 export declare class CatalogGraphQLClient extends AbstractGraphQLClient {
-    /**
-     * The base path of the Catalog API
-     */
-    private ROOT_PATH;
     /**
      * The base path of the API
      */

package/build/catalog/catalogGraphQLClient.js

@@ -6,14 +6,10 @@ const abstractGraphQLClient_1 = require("../abstractGraphQLClient");
 class CatalogGraphQLClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
     constructor() {
         super(...arguments);
-        /**
-         * The base path of the Catalog API
-         */
-        this.ROOT_PATH = 'catalog/';
         /**
          * The base path of the API
          */
-        this.basePath = this.ROOT_PATH;
+        this.basePath = 'catalog/';
         /**
          * The Path of graphql catalog API
          */

package/build/catalog/index.d.ts

@@ -1,2 +1,2 @@
-export * from './types/catalogGraphQLTypes';
 export * from './catalogGraphQLClient';
+export * from './types/catalogGraphQLTypes';

package/build/catalog/index.js

@@ -10,6 +10,6 @@ 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("./types/catalogGraphQLTypes"), exports);
 __exportStar(require("./catalogGraphQLClient"), exports);
+__exportStar(require("./types/catalogGraphQLTypes"), exports);
 //# sourceMappingURL=index.js.map

package/build/contact/contactClient.d.ts

@@ -22,10 +22,6 @@ export declare type ContactRequestType = {
     [ContactRequestFields.COLUMN_ROLE]: string;
 };
 export declare class ContactClient extends AbstractClient {
-    /**
-     * The base path of the Customers API
-     */
-    private ROOT_PATH;
     /**
      * The base path of the API
      */

package/build/contact/contactClient.js

@@ -19,14 +19,10 @@ var ContactRequestFields;
 class ContactClient extends abstractClient_1.AbstractClient {
     constructor() {
         super(...arguments);
-        /**
-         * The base path of the Customers API
-         */
-        this.ROOT_PATH = '/contacts';
         /**
          * The base path of the API
          */
-        this.basePath = this.ROOT_PATH;
+        this.basePath = '/contacts';
     }
     async createContact(postData, parameters = {}) {
         return new getResult_1.GetResult(contactCreate_1.ContactCreate, await this.post(postData, parameters));

package/build/contact/index.d.ts

@@ -1,4 +1,4 @@
+export * from './contactClient';
+export * from './entities/contact';
 export * from './entities/contactCreate';
 export * from './entities/contactList';
-export * from './entities/contact';
-export * from './contactClient';

package/build/contact/index.js

@@ -10,8 +10,8 @@ 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("./contactClient"), exports);
+__exportStar(require("./entities/contact"), exports);
 __exportStar(require("./entities/contactCreate"), exports);
 __exportStar(require("./entities/contactList"), exports);
-__exportStar(require("./entities/contact"), exports);
-__exportStar(require("./contactClient"), exports);
 //# sourceMappingURL=index.js.map

package/build/customers/index.d.ts

@@ -1,8 +1,8 @@
+export * from './customersClient';
 export * from './entities/customers/contact/contact';
-export * from './entities/invitations/contact/invitationContact';
-export * from './entities/customers/details/details';
-export * from './entities/invitations/company/company';
 export * from './entities/customers/customer';
+export * from './entities/customers/details/details';
 export * from './entities/dataCustomers';
 export * from './entities/dataInvitation';
-export * from './customersClient';
+export * from './entities/invitations/company/company';
+export * from './entities/invitations/contact/invitationContact';

package/build/customers/index.js

@@ -10,12 +10,12 @@ 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("./customersClient"), exports);
 __exportStar(require("./entities/customers/contact/contact"), exports);
-__exportStar(require("./entities/invitations/contact/invitationContact"), exports);
-__exportStar(require("./entities/customers/details/details"), exports);
-__exportStar(require("./entities/invitations/company/company"), exports);
 __exportStar(require("./entities/customers/customer"), exports);
+__exportStar(require("./entities/customers/details/details"), exports);
 __exportStar(require("./entities/dataCustomers"), exports);
 __exportStar(require("./entities/dataInvitation"), exports);
-__exportStar(require("./customersClient"), exports);
+__exportStar(require("./entities/invitations/company/company"), exports);
+__exportStar(require("./entities/invitations/contact/invitationContact"), exports);
 //# sourceMappingURL=index.js.map

package/build/general/index.d.ts

@@ -1,3 +1,3 @@
 export * from './checkDomainClient';
-export * from './whoAmIClient';
 export * from './entities/whoAmI';
+export * from './whoAmIClient';

package/build/general/index.js

@@ -11,6 +11,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./checkDomainClient"), exports);
-__exportStar(require("./whoAmIClient"), exports);
 __exportStar(require("./entities/whoAmI"), exports);
+__exportStar(require("./whoAmIClient"), exports);
 //# sourceMappingURL=index.js.map

package/build/index.d.ts

@@ -1,17 +1,18 @@
-import * as ContactInformation from './contact';
-export * from './publicApiClient';
-export * from './publicGraphQLClient';
-export * from './abstractEntity';
 export * from './abstractClient';
+export * from './abstractEntity';
 export * from './abstractGraphQLClient';
 export * from './campaign/';
 export * from './catalog/';
 export * from './consumption';
-export { ContactInformation };
 export * from './customers/';
+export * from './exception/';
 export * from './general/';
+export * from './getResult';
 export * from './licenses/';
 export * from './orders/';
+export * from './publicApiClient';
+export * from './publicGraphQLClient';
 export * from './shared/';
 export * from './subscriptions/';
-export * from './getResult';
+export { ContactInformation };
+import * as ContactInformation from './contact';

package/build/index.js

@@ -11,6 +11,9 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
+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);
+};
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
@@ -18,26 +21,24 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-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 });
 exports.ContactInformation = void 0;
-const ContactInformation = __importStar(require("./contact"));
-exports.ContactInformation = ContactInformation;
-__exportStar(require("./publicApiClient"), exports);
-__exportStar(require("./publicGraphQLClient"), exports);
-__exportStar(require("./abstractEntity"), exports);
 __exportStar(require("./abstractClient"), exports);
+__exportStar(require("./abstractEntity"), exports);
 __exportStar(require("./abstractGraphQLClient"), exports);
 __exportStar(require("./campaign/"), exports);
 __exportStar(require("./catalog/"), exports);
 __exportStar(require("./consumption"), exports);
 __exportStar(require("./customers/"), exports);
+__exportStar(require("./exception/"), exports);
 __exportStar(require("./general/"), exports);
+__exportStar(require("./getResult"), exports);
 __exportStar(require("./licenses/"), exports);
 __exportStar(require("./orders/"), exports);
+__exportStar(require("./publicApiClient"), exports);
+__exportStar(require("./publicGraphQLClient"), exports);
 __exportStar(require("./shared/"), exports);
 __exportStar(require("./subscriptions/"), exports);
-__exportStar(require("./getResult"), exports);
+const ContactInformation = __importStar(require("./contact"));
+exports.ContactInformation = ContactInformation;
 //# sourceMappingURL=index.js.map

package/build/licenses/index.d.ts

@@ -1,23 +1,24 @@
-export * from './licensesClient';
+export * from './entities/filterFindResult';
+export * from './entities/findResult';
+export * from './entities/getLicense/actionMessagesGetResult';
+export * from './entities/getLicense/actionsGetResult';
+export * from './entities/getLicense/buySellFindResult';
+export * from './entities/getLicense/licenseGetResult';
+export * from './entities/getLicense/licensePriceGetResult';
+export * from './entities/getLicense/orderGetResult';
+export * from './entities/getResult/getLicenseResult';
 export * from './entities/license/activeSeatsFindResult';
 export * from './entities/license/configFindResult';
 export * from './entities/license/licenseFindResult';
 export * from './entities/license/priceFindResult';
 export * from './entities/license/warningFindResult';
-export * from './entities/offer/priceband/identifiers/arrowsphereFindResult';
+export * from './entities/offer/actionFlagsFindResult';
+export * from './entities/offer/offerFindResult';
+export * from './entities/offer/priceBandFindResult';
 export * from './entities/offer/priceband/billingFindResult';
 export * from './entities/offer/priceband/identifiersFindResult';
 export * from './entities/offer/priceband/priceBandActionFlagsFindResult';
 export * from './entities/offer/priceband/priceBandPriceFindResult';
 export * from './entities/offer/priceband/saleConstraintsFindResult';
-export * from './entities/offer/actionFlagsFindResult';
-export * from './entities/offer/offerFindResult';
-export * from './entities/offer/priceBandFindResult';
-export * from '../licenses/entities/getLicense/actionMessagesGetResult';
-export * from '../licenses/entities/getLicense/actionsGetResult';
-export * from '../licenses/entities/getLicense/buySellFindResult';
-export * from '../licenses/entities/getLicense/licenseGetResult';
-export * from '../licenses/entities/getLicense/licensePriceGetResult';
-export * from '../licenses/entities/getLicense/orderGetResult';
-export * from './entities/filterFindResult';
-export * from './entities/findResult';
+export * from './entities/offer/priceband/identifiers/arrowsphereFindResult';
+export * from './licensesClient';

package/build/licenses/index.js

@@ -10,27 +10,28 @@ 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("./licensesClient"), exports);
+__exportStar(require("./entities/filterFindResult"), exports);
+__exportStar(require("./entities/findResult"), exports);
+__exportStar(require("./entities/getLicense/actionMessagesGetResult"), exports);
+__exportStar(require("./entities/getLicense/actionsGetResult"), exports);
+__exportStar(require("./entities/getLicense/buySellFindResult"), exports);
+__exportStar(require("./entities/getLicense/licenseGetResult"), exports);
+__exportStar(require("./entities/getLicense/licensePriceGetResult"), exports);
+__exportStar(require("./entities/getLicense/orderGetResult"), exports);
+__exportStar(require("./entities/getResult/getLicenseResult"), exports);
 __exportStar(require("./entities/license/activeSeatsFindResult"), exports);
 __exportStar(require("./entities/license/configFindResult"), exports);
 __exportStar(require("./entities/license/licenseFindResult"), exports);
 __exportStar(require("./entities/license/priceFindResult"), exports);
 __exportStar(require("./entities/license/warningFindResult"), exports);
-__exportStar(require("./entities/offer/priceband/identifiers/arrowsphereFindResult"), exports);
+__exportStar(require("./entities/offer/actionFlagsFindResult"), exports);
+__exportStar(require("./entities/offer/offerFindResult"), exports);
+__exportStar(require("./entities/offer/priceBandFindResult"), exports);
 __exportStar(require("./entities/offer/priceband/billingFindResult"), exports);
 __exportStar(require("./entities/offer/priceband/identifiersFindResult"), exports);
 __exportStar(require("./entities/offer/priceband/priceBandActionFlagsFindResult"), exports);
 __exportStar(require("./entities/offer/priceband/priceBandPriceFindResult"), exports);
 __exportStar(require("./entities/offer/priceband/saleConstraintsFindResult"), exports);
-__exportStar(require("./entities/offer/actionFlagsFindResult"), exports);
-__exportStar(require("./entities/offer/offerFindResult"), exports);
-__exportStar(require("./entities/offer/priceBandFindResult"), exports);
-__exportStar(require("../licenses/entities/getLicense/actionMessagesGetResult"), exports);
-__exportStar(require("../licenses/entities/getLicense/actionsGetResult"), exports);
-__exportStar(require("../licenses/entities/getLicense/buySellFindResult"), exports);
-__exportStar(require("../licenses/entities/getLicense/licenseGetResult"), exports);
-__exportStar(require("../licenses/entities/getLicense/licensePriceGetResult"), exports);
-__exportStar(require("../licenses/entities/getLicense/orderGetResult"), exports);
-__exportStar(require("./entities/filterFindResult"), exports);
-__exportStar(require("./entities/findResult"), exports);
+__exportStar(require("./entities/offer/priceband/identifiers/arrowsphereFindResult"), exports);
+__exportStar(require("./licensesClient"), exports);
 //# sourceMappingURL=index.js.map

package/build/licenses/licensesClient.d.ts

@@ -194,10 +194,6 @@ export declare type PutFriendlyName = {
     [LicenseGetFields.COLUMN_FRIENDLY_NAME]: string;
 };
 export declare class LicensesClient extends AbstractClient {
-    /**
-     * The base path of the Licenses API
-     */
-    private ROOT_PATH;
     /**
      * The base path of the API
      */

package/build/licenses/licensesClient.js

@@ -111,14 +111,10 @@ var LicenseFindParameters;
 class LicensesClient extends abstractClient_1.AbstractClient {
     constructor() {
         super(...arguments);
-        /**
-         * The base path of the Licenses API
-         */
-        this.ROOT_PATH = '/licenses/';
         /**
          * The base path of the API
          */
-        this.basePath = this.ROOT_PATH;
+        this.basePath = '/licenses/';
         /**
          * The path of the Find endpoint
          */

package/build/orders/index.d.ts

@@ -1,7 +1,7 @@
+export * from './entities/dataListOrders';
+export * from './entities/orders/order';
+export * from './entities/orders/partner/partner';
 export * from './entities/orders/products/prices/productPrices';
 export * from './entities/orders/products/products';
-export * from './entities/orders/partner/partner';
-export * from './entities/orders/order';
-export * from './entities/dataListOrders';
 export * from './entities/referenceLink';
 export * from './ordersClient';

package/build/orders/index.js

@@ -10,11 +10,11 @@ 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/dataListOrders"), exports);
+__exportStar(require("./entities/orders/order"), exports);
+__exportStar(require("./entities/orders/partner/partner"), exports);
 __exportStar(require("./entities/orders/products/prices/productPrices"), exports);
 __exportStar(require("./entities/orders/products/products"), exports);
-__exportStar(require("./entities/orders/partner/partner"), exports);
-__exportStar(require("./entities/orders/order"), exports);
-__exportStar(require("./entities/dataListOrders"), exports);
 __exportStar(require("./entities/referenceLink"), exports);
 __exportStar(require("./ordersClient"), exports);
 //# sourceMappingURL=index.js.map

package/build/orders/ordersClient.d.ts

@@ -37,12 +37,6 @@ export declare type CreateOrderInputType = {
     }>;
 };
 export declare class OrdersClient extends AbstractClient {
-    /**
-     * The base path of the Orders API
-     *
-     * TODO: Actually we use php endpoint and we need to add "/index.php/api" before "/orders" remove "/index.php/api" when endpoint is available in nodejs
-     */
-    private ROOT_PATH;
     /**
      * The base path of the API
      */

package/build/orders/ordersClient.js

@@ -24,16 +24,10 @@ var CreateOrderInputFields;
 class OrdersClient extends abstractClient_1.AbstractClient {
     constructor() {
         super(...arguments);
-        /**
-         * The base path of the Orders API
-         *
-         * TODO: Actually we use php endpoint and we need to add "/index.php/api" before "/orders" remove "/index.php/api" when endpoint is available in nodejs
-         */
-        this.ROOT_PATH = '/index.php/api/orders';
         /**
          * The base path of the API
          */
-        this.basePath = this.ROOT_PATH;
+        this.basePath = '/index.php/api/orders';
     }
     async create(postData, parameters = {}) {
         return new getResult_1.GetResult(referenceLink_1.ReferenceLink, await this.post(postData, parameters));

package/build/subscriptions/index.d.ts

@@ -1,3 +1,3 @@
-export * from './subscriptionsClient';
 export * from './entities/subscription';
 export * from './entities/subscriptionsListResult';
+export * from './subscriptionsClient';

package/build/subscriptions/index.js

@@ -10,7 +10,7 @@ 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("./subscriptionsClient"), exports);
 __exportStar(require("./entities/subscription"), exports);
 __exportStar(require("./entities/subscriptionsListResult"), exports);
+__exportStar(require("./subscriptionsClient"), exports);
 //# sourceMappingURL=index.js.map

package/build/subscriptions/subscriptionsClient.d.ts

@@ -30,10 +30,6 @@ export declare type SubscriptionsListData = {
     };
 };
 export declare class SubscriptionsClient extends AbstractClient {
-    /**
-     * The base path of the Subscriptions API
-     */
-    private ROOT_PATH;
     /**
      * The base path of the API
      */
@@ -50,7 +46,6 @@ export declare class SubscriptionsClient extends AbstractClient {
      * Calls the subscriptions API list endpoint
      *
      * @param data - List payload
-     * @param parameters - Extra parameters to pass
      *
      * @returns Promise\<AxiosResponse\<{@link SubscriptionsListData}\>\>   */
     listRaw(data?: SubscriptionsListPayload): Promise<SubscriptionsListData>;
@@ -62,7 +57,6 @@ export declare class SubscriptionsClient extends AbstractClient {
      * @param postData - List payload
      * @param perPage - Number of results per page
      * @param page - Page number to fetch
-     * @param parameters - Extra parameters to pass
      *
      * @returns Promise\<{@link SubscriptionsListResult}\>
      *

package/build/subscriptions/subscriptionsClient.js

@@ -9,14 +9,10 @@ const subscriptionsListResult_1 = require("./entities/subscriptionsListResult");
 class SubscriptionsClient extends abstractClient_1.AbstractClient {
     constructor() {
         super(...arguments);
-        /**
-         * The base path of the Subscriptions API
-         */
-        this.ROOT_PATH = '/subscriptions';
         /**
          * The base path of the API
          */
-        this.basePath = this.ROOT_PATH;
+        this.basePath = '/subscriptions';
         /**
          * The path of the List endpoint
          */
@@ -30,7 +26,6 @@ class SubscriptionsClient extends abstractClient_1.AbstractClient {
      * Calls the subscriptions API list endpoint
      *
      * @param data - List payload
-     * @param parameters - Extra parameters to pass
      *
      * @returns Promise\<AxiosResponse\<{@link SubscriptionsListData}\>\>   */
     async listRaw(data = {}) {
@@ -45,7 +40,6 @@ class SubscriptionsClient extends abstractClient_1.AbstractClient {
      * @param postData - List payload
      * @param perPage - Number of results per page
      * @param page - Page number to fetch
-     * @param parameters - Extra parameters to pass
      *
      * @returns Promise\<{@link SubscriptionsListResult}\>
      *

package/package.json

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