@arrowsphere/api-client 3.97.0 → 3.98.0-rc.ckh.1

package/CHANGELOG.md

@@ -3,6 +3,11 @@
 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.98.0] - 2024.02.13
+
+### Added
+- [billing] add generate billing export async
+
 ## [3.97.0] - 2024.02.12
 
 ### Updated

package/build/billing/billingClient.d.ts

@@ -0,0 +1,59 @@
+import { AbstractRestfulClient } from '../abstractRestfulClient';
+import { GetResult } from '../getResult';
+import { BillingExportAsyncRequest } from './entities/export/exportAsyncRequest';
+export declare type GenerateExportAsyncRequestPayload = {
+    outputFormat?: {
+        file: 'csv' | 'xlsx';
+        date: string;
+    };
+    exportTypeReference: string;
+    filters: {
+        issueDate?: {
+            from: string;
+            to: string;
+        };
+        validationDate?: {
+            from: string;
+            to: string;
+        };
+        reportPeriod?: {
+            from: string;
+            to: string;
+        };
+        subscriptionDate?: {
+            from: string;
+            to: string;
+        };
+        createdAt?: {
+            from: string;
+            to: string;
+        };
+        classifications?: string[];
+        vendors?: string[];
+        programs?: string[];
+        marketplaces?: string[];
+        sequences?: string[];
+        references?: string[];
+        resellerXspRefs?: string[];
+        resellerCompanyTags?: string[];
+        customerXspRefs?: string[];
+        vendorSubscriptionIds?: string[];
+        friendlyNames?: string[];
+        arrowSku?: string;
+    };
+    callbackUrl: string;
+};
+export declare class BillingClient extends AbstractRestfulClient {
+    /**
+     * The base path of the API
+     */
+    protected basePath: string;
+    /**
+     * Generates a billing export asynchronously.
+     *
+     * @param {GenerateExportAsyncRequestPayload} payload - The request payload for generating the export.
+     *
+     * @return {Promise<GetResult<BillingExportAsyncRequest>>} - A promise that resolves to the result of the export request.
+     */
+    generateExportAsync(payload: GenerateExportAsyncRequestPayload): Promise<GetResult<BillingExportAsyncRequest>>;
+}

package/build/billing/billingClient.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingClient = void 0;
+const abstractRestfulClient_1 = require("../abstractRestfulClient");
+const getResult_1 = require("../getResult");
+const exportAsyncRequest_1 = require("./entities/export/exportAsyncRequest");
+class BillingClient extends abstractRestfulClient_1.AbstractRestfulClient {
+    constructor() {
+        super(...arguments);
+        /**
+         * The base path of the API
+         */
+        this.basePath = '/billing/erp';
+    }
+    /**
+     * Generates a billing export asynchronously.
+     *
+     * @param {GenerateExportAsyncRequestPayload} payload - The request payload for generating the export.
+     *
+     * @return {Promise<GetResult<BillingExportAsyncRequest>>} - A promise that resolves to the result of the export request.
+     */
+    async generateExportAsync(payload) {
+        this.path = `/exports/async`;
+        return new getResult_1.GetResult(exportAsyncRequest_1.BillingExportAsyncRequest, await this.post(payload));
+    }
+}
+exports.BillingClient = BillingClient;
+//# sourceMappingURL=billingClient.js.map

package/build/billing/entities/export/exportAsyncRequest.d.ts

@@ -0,0 +1,13 @@
+import { AbstractEntity } from '../../../abstractEntity';
+export declare enum BillingExportAsyncRequestFields {
+    COLUMN_REQUEST_REF = "requestRef"
+}
+export declare type BillingExportAsyncRequestType = {
+    [BillingExportAsyncRequestFields.COLUMN_REQUEST_REF]: string;
+};
+export declare class BillingExportAsyncRequest extends AbstractEntity<BillingExportAsyncRequestType> {
+    #private;
+    constructor(billingExportAsyncRequestResponse: BillingExportAsyncRequestType);
+    get requestRef(): string;
+    toJSON(): BillingExportAsyncRequestType;
+}

package/build/billing/entities/export/exportAsyncRequest.js

@@ -0,0 +1,38 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _BillingExportAsyncRequest_requestRef;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingExportAsyncRequest = exports.BillingExportAsyncRequestFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+var BillingExportAsyncRequestFields;
+(function (BillingExportAsyncRequestFields) {
+    BillingExportAsyncRequestFields["COLUMN_REQUEST_REF"] = "requestRef";
+})(BillingExportAsyncRequestFields = exports.BillingExportAsyncRequestFields || (exports.BillingExportAsyncRequestFields = {}));
+class BillingExportAsyncRequest extends abstractEntity_1.AbstractEntity {
+    constructor(billingExportAsyncRequestResponse) {
+        super(billingExportAsyncRequestResponse);
+        _BillingExportAsyncRequest_requestRef.set(this, void 0);
+        __classPrivateFieldSet(this, _BillingExportAsyncRequest_requestRef, billingExportAsyncRequestResponse[BillingExportAsyncRequestFields.COLUMN_REQUEST_REF], "f");
+    }
+    get requestRef() {
+        return __classPrivateFieldGet(this, _BillingExportAsyncRequest_requestRef, "f");
+    }
+    toJSON() {
+        return {
+            [BillingExportAsyncRequestFields.COLUMN_REQUEST_REF]: this.requestRef,
+        };
+    }
+}
+exports.BillingExportAsyncRequest = BillingExportAsyncRequest;
+_BillingExportAsyncRequest_requestRef = new WeakMap();
+//# sourceMappingURL=exportAsyncRequest.js.map

package/build/billing/index.d.ts

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

package/build/billing/index.js

@@ -0,0 +1,19 @@
+"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("./entities/export/exportAsyncRequest"), exports);
+__exportStar(require("./billingClient"), exports);
+//# sourceMappingURL=index.js.map

package/build/index.d.ts

@@ -27,6 +27,7 @@ export * from './subscriptions/';
 export * from './supportCenter/';
 export * from './securityScore/';
 export * from './user/';
+export * from './billing/';
 export { WellArchitected };
 import * as WellArchitected from './wellArchitected';
 export { ContactInformation };

package/build/index.js

@@ -56,6 +56,7 @@ __exportStar(require("./subscriptions/"), exports);
 __exportStar(require("./supportCenter/"), exports);
 __exportStar(require("./securityScore/"), exports);
 __exportStar(require("./user/"), exports);
+__exportStar(require("./billing/"), exports);
 const WellArchitected = __importStar(require("./wellArchitected"));
 exports.WellArchitected = WellArchitected;
 const ContactInformation = __importStar(require("./contact"));

package/build/publicApiClient.d.ts

@@ -17,6 +17,7 @@ import { RegisterClient, StandardsClient } from './security';
 import { PartnerClient } from './partner';
 import { OrganizationUnitClient } from './organisationUnit';
 import { QuotesClient } from './quotes';
+import { BillingClient } from './billing';
 /**
  * Public API Client class, should be the main entry point for your calls
  */
@@ -97,5 +98,6 @@ export declare class PublicApiClient extends AbstractRestfulClient {
     getUserClient(configuration?: ConfigurationsClient): UserClient;
     getNotificationsClient(configuration?: ConfigurationsClient): NotificationsClient;
     getOrganizationUnitClient(configuration?: ConfigurationsClient): OrganizationUnitClient;
+    getBillingClient(configuration?: ConfigurationsClient): BillingClient;
 }
 export default PublicApiClient;

package/build/publicApiClient.js

@@ -20,6 +20,7 @@ const security_1 = require("./security");
 const partner_1 = require("./partner");
 const organisationUnit_1 = require("./organisationUnit");
 const quotes_1 = require("./quotes");
+const billing_1 = require("./billing");
 /**
  * Public API Client class, should be the main entry point for your calls
  */
@@ -197,6 +198,11 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.applyConfig(client);
         return client;
     }
+    getBillingClient(configuration) {
+        const client = new billing_1.BillingClient(configuration);
+        this.applyConfig(client);
+        return client;
+    }
 }
 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.97.0",
+  "version": "3.98.0-rc.ckh.1",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",