@arrowsphere/api-client 3.187.0-rc-jpb.1 → 3.187.0-rc-cni-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.187.0] - 2025.04.17
+
+### Modified
+- [organizationUnit] Change the URL Endpoint BasePath
+
+## [3.186.0] - 2025.04.15
+
+### Added
+- [graphql-api] add endpoint `getAttachmentsOrder` to get order attachments list
+- [graphql-api] add endpoint `deleteAttachmentOrder` to delete one order attachment
+- [graphql-api] add endpoint `uploadAttachmentOrder` to add new attachment to an order
+
 ## [3.185.0] - 2025.04.11
 
 ### Added

package/build/licenses/entities/filterFindResult.d.ts

@@ -1,15 +1,10 @@
 import { AbstractEntity } from '../../abstractEntity';
 import { LicenseFindResultFields } from './license/licenseFindResult';
-declare type FilterFindResultDataIterable = {
-    [field in LicenseFindResultFields]?: unknown;
-};
 /**
  * Filter data values
  */
-export declare type FilterFindResultDataValues = FilterFindResultDataIterable | LicenseFilterAggregationType[];
-export declare type LicenseFilterAggregationType = {
-    count: number;
-    values: string[];
+export declare type FilterFindResultDataValues = {
+    [field in LicenseFindResultFields]?: unknown;
 };
 /**
  * Filter data
@@ -49,4 +44,3 @@ export declare class FilterFindResult extends AbstractEntity<FilterFindResultDat
      */
     toJSON(): FilterFindResultData;
 }
-export {};

package/build/licenses/licensesClient.d.ts

@@ -32,10 +32,6 @@ import { LicenceCouponCodeHistoryResult } from './entities/history/licenceCoupon
  * Parameters passable to the request for refining search.
  */
 export declare enum LicenseFindParameters {
-    /**
-     * The key for aggregation search query parameter (to request extra aggregation, which are not provided by default)
-     */
-    DATA_AGGREGATION = "aggregations",
     /**
      * The key for keyword search query parameter (to search one string in all available search fields)
      */
@@ -181,7 +177,6 @@ export declare type LicenseRawFiltersParameters = {
  * Payload to pass the find request. Contains keyword(s), sort options, column filters and highlight option.
  */
 export declare type LicenseFindPayload = {
-    [LicenseFindParameters.DATA_AGGREGATION]?: string[];
     [LicenseFindParameters.DATA_KEYWORD]?: string;
     [LicenseFindParameters.DATA_KEYWORDS]?: LicenseKeywordsParameters;
     [LicenseFindParameters.DATA_FILTERS]?: LicenseFiltersParameters;
@@ -190,7 +185,6 @@ export declare type LicenseFindPayload = {
     [LicenseFindParameters.DATA_HIGHLIGHT]?: boolean;
 };
 export declare type LicenseFindRawPayload = {
-    [LicenseFindParameters.DATA_AGGREGATION]?: string[];
     [LicenseFindParameters.DATA_KEYWORD]?: string;
     [LicenseFindParameters.DATA_KEYWORDS]?: {
         license?: LicenseRawKeywordsParametersLicence;

package/build/licenses/licensesClient.js

@@ -27,10 +27,6 @@ const licenceCouponCodeHistoryResult_1 = require("./entities/history/licenceCoup
  */
 var LicenseFindParameters;
 (function (LicenseFindParameters) {
-    /**
-     * The key for aggregation search query parameter (to request extra aggregation, which are not provided by default)
-     */
-    LicenseFindParameters["DATA_AGGREGATION"] = "aggregations";
     /**
      * The key for keyword search query parameter (to search one string in all available search fields)
      */
@@ -261,7 +257,6 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.setPerPage(perPage);
         this.setPage(page);
         const rawLicensePayload = {
-            aggregations: postData.aggregations,
             keyword: postData.keyword,
             highlight: postData.highlight,
         };
@@ -273,14 +268,6 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
                 ...this.createKeywords(postData.keywords, 'endCustomerOrganizationUnit'),
             };
         }
-        if (postData.keywords) {
-            // Flatten with prefix for each type of keyword (license and offer)
-            rawLicensePayload.keywords = {
-                ...this.createKeywords(postData.keywords, 'license'),
-                ...this.createKeywords(postData.keywords, 'offer'),
-                ...this.createKeywords(postData.keywords, 'endCustomerOrganizationUnit'),
-            };
-        }
         if (postData.filters) {
             // Flatten with prefix for each type of filter (license and offer)
             rawLicensePayload.filters = {

package/build/orders/entities/orders/attachment.d.ts

@@ -0,0 +1,34 @@
+import { AbstractEntity } from '../../../abstractEntity';
+export declare enum AttachmentOrderFields {
+    COLUMN_LAST_MODIFIED = "lastModified",
+    COLUMN_METADATA = "metadata",
+    COLUMN_NAME = "name",
+    COLUMN_URL = "url"
+}
+export declare type AttachmentOrderType = {
+    [AttachmentOrderFields.COLUMN_LAST_MODIFIED]: string;
+    [AttachmentOrderFields.COLUMN_METADATA]?: Record<string, string>;
+    [AttachmentOrderFields.COLUMN_NAME]: string;
+    [AttachmentOrderFields.COLUMN_URL]: string;
+};
+export declare enum AttachmentsOrderListFields {
+    COLUMN_ATTACHMENTS = "attachments"
+}
+export declare type AttachmentsOrderListType = {
+    [AttachmentsOrderListFields.COLUMN_ATTACHMENTS]: AttachmentOrderType[];
+};
+export declare class AttachmentOrder extends AbstractEntity<AttachmentOrderType> {
+    #private;
+    constructor(attachmentOrderTypeInput: AttachmentOrderType);
+    get lastModified(): string;
+    get metadata(): Record<string, string> | undefined;
+    get name(): string;
+    get url(): string;
+    toJSON(): AttachmentOrderType;
+}
+export declare class AttachmentsListOrder extends AbstractEntity<AttachmentsOrderListType> {
+    #private;
+    constructor(attachmentsListOrderTypeInput: AttachmentsOrderListType);
+    get attachments(): AttachmentOrder[];
+    toJSON(): AttachmentsOrderListType;
+}

package/build/orders/entities/orders/attachment.js

@@ -0,0 +1,80 @@
+"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 _AttachmentOrder_lastModified, _AttachmentOrder_metadata, _AttachmentOrder_name, _AttachmentOrder_url, _AttachmentsListOrder_attachments;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentsListOrder = exports.AttachmentOrder = exports.AttachmentsOrderListFields = exports.AttachmentOrderFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+var AttachmentOrderFields;
+(function (AttachmentOrderFields) {
+    AttachmentOrderFields["COLUMN_LAST_MODIFIED"] = "lastModified";
+    AttachmentOrderFields["COLUMN_METADATA"] = "metadata";
+    AttachmentOrderFields["COLUMN_NAME"] = "name";
+    AttachmentOrderFields["COLUMN_URL"] = "url";
+})(AttachmentOrderFields = exports.AttachmentOrderFields || (exports.AttachmentOrderFields = {}));
+var AttachmentsOrderListFields;
+(function (AttachmentsOrderListFields) {
+    AttachmentsOrderListFields["COLUMN_ATTACHMENTS"] = "attachments";
+})(AttachmentsOrderListFields = exports.AttachmentsOrderListFields || (exports.AttachmentsOrderListFields = {}));
+class AttachmentOrder extends abstractEntity_1.AbstractEntity {
+    constructor(attachmentOrderTypeInput) {
+        super(attachmentOrderTypeInput);
+        _AttachmentOrder_lastModified.set(this, void 0);
+        _AttachmentOrder_metadata.set(this, void 0);
+        _AttachmentOrder_name.set(this, void 0);
+        _AttachmentOrder_url.set(this, void 0);
+        __classPrivateFieldSet(this, _AttachmentOrder_lastModified, attachmentOrderTypeInput[AttachmentOrderFields.COLUMN_LAST_MODIFIED], "f");
+        __classPrivateFieldSet(this, _AttachmentOrder_metadata, attachmentOrderTypeInput[AttachmentOrderFields.COLUMN_METADATA], "f");
+        __classPrivateFieldSet(this, _AttachmentOrder_name, attachmentOrderTypeInput[AttachmentOrderFields.COLUMN_NAME], "f");
+        __classPrivateFieldSet(this, _AttachmentOrder_url, attachmentOrderTypeInput[AttachmentOrderFields.COLUMN_URL], "f");
+    }
+    get lastModified() {
+        return __classPrivateFieldGet(this, _AttachmentOrder_lastModified, "f");
+    }
+    get metadata() {
+        return __classPrivateFieldGet(this, _AttachmentOrder_metadata, "f");
+    }
+    get name() {
+        return __classPrivateFieldGet(this, _AttachmentOrder_name, "f");
+    }
+    get url() {
+        return __classPrivateFieldGet(this, _AttachmentOrder_url, "f");
+    }
+    toJSON() {
+        return {
+            [AttachmentOrderFields.COLUMN_LAST_MODIFIED]: this.lastModified,
+            [AttachmentOrderFields.COLUMN_METADATA]: this.metadata,
+            [AttachmentOrderFields.COLUMN_NAME]: this.name,
+            [AttachmentOrderFields.COLUMN_URL]: this.url,
+        };
+    }
+}
+exports.AttachmentOrder = AttachmentOrder;
+_AttachmentOrder_lastModified = new WeakMap(), _AttachmentOrder_metadata = new WeakMap(), _AttachmentOrder_name = new WeakMap(), _AttachmentOrder_url = new WeakMap();
+class AttachmentsListOrder extends abstractEntity_1.AbstractEntity {
+    constructor(attachmentsListOrderTypeInput) {
+        super(attachmentsListOrderTypeInput);
+        _AttachmentsListOrder_attachments.set(this, void 0);
+        __classPrivateFieldSet(this, _AttachmentsListOrder_attachments, attachmentsListOrderTypeInput[AttachmentsOrderListFields.COLUMN_ATTACHMENTS].map((attachment) => new AttachmentOrder(attachment)), "f");
+    }
+    get attachments() {
+        return __classPrivateFieldGet(this, _AttachmentsListOrder_attachments, "f");
+    }
+    toJSON() {
+        return {
+            [AttachmentsOrderListFields.COLUMN_ATTACHMENTS]: this.attachments.map((attachment) => attachment.toJSON()),
+        };
+    }
+}
+exports.AttachmentsListOrder = AttachmentsListOrder;
+_AttachmentsListOrder_attachments = new WeakMap();
+//# sourceMappingURL=attachment.js.map

package/build/orders/index.d.ts

@@ -1,4 +1,5 @@
 export * from './entities/dataListOrders';
+export * from './entities/orders/attachment';
 export * from './entities/orders/order';
 export * from './entities/orders/updateOrderResult';
 export * from './entities/orders/partner/partner';

package/build/orders/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./entities/dataListOrders"), exports);
+__exportStar(require("./entities/orders/attachment"), exports);
 __exportStar(require("./entities/orders/order"), exports);
 __exportStar(require("./entities/orders/updateOrderResult"), exports);
 __exportStar(require("./entities/orders/partner/partner"), exports);

package/build/orders/ordersClient.d.ts

@@ -3,6 +3,7 @@ import { GetResult } from '../getResult';
 import { DataListOrders } from './entities/dataListOrders';
 import { ReferenceLink } from './entities/referenceLink';
 import { UpdateOrderResult } from './entities/orders/updateOrderResult';
+import { AttachmentOrder, AttachmentsListOrder } from './entities/orders/attachment';
 export declare enum CreateOrderInputFields {
     COLUMN_CUSTOMER = "customer",
     COLUMN_REFERENCE = "reference",
@@ -164,6 +165,14 @@ export declare enum UpdateAdditionalInformationOrderInputFields {
 export declare type UpdateAdditionalInformationOrderInputType = {
     [UpdateAdditionalInformationOrderInputFields.COLUMN_DATA]: UpdateAdditionalInformationItemOrderInputType[];
 };
+export declare enum UploadAttachmentOrderInputFields {
+    COLUMN_NAME = "name",
+    COLUMN_FILE_ENCODED = "fileEncoded"
+}
+export declare type UploadAttachmentOrderInputType = {
+    [UploadAttachmentOrderInputFields.COLUMN_NAME]: string;
+    [UploadAttachmentOrderInputFields.COLUMN_FILE_ENCODED]: string;
+};
 export declare class OrdersClient extends AbstractRestfulClient {
     /**
      * The base path of the API
@@ -180,4 +189,7 @@ export declare class OrdersClient extends AbstractRestfulClient {
     validateOrder(orderReference: string, parameters?: Parameters): Promise<void>;
     updateStaffContributorsOrder(orderReference: string, payload: UpdateContributorOrderInputType, parameters?: Parameters): Promise<void>;
     updateAdditionalInformationOrder(orderReference: string, payload: UpdateAdditionalInformationOrderInputType, parameters?: Parameters): Promise<void>;
+    getAttachmentsOrder(orderReference: string, perPage?: number, page?: number, parameters?: Parameters): Promise<GetResult<AttachmentsListOrder>>;
+    deleteAttachmentOrder(orderReference: string, name: string, parameters?: Parameters): Promise<void>;
+    uploadAttachmentOrder(orderReference: string, payload: UploadAttachmentOrderInputType, parameters?: Parameters): Promise<GetResult<AttachmentOrder>>;
 }

package/build/orders/ordersClient.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrdersClient = exports.UpdateAdditionalInformationOrderInputFields = exports.UpdateAdditionalInformationItemOrderInputFields = exports.UpdateContributorOrderInputFields = exports.UpdateContributorItemOrderInputFields = exports.UpdateOrderInputFields = exports.StaffTypeEnum = exports.scenarioType = exports.CreateOrderInputFields = void 0;
+exports.OrdersClient = exports.UploadAttachmentOrderInputFields = exports.UpdateAdditionalInformationOrderInputFields = exports.UpdateAdditionalInformationItemOrderInputFields = exports.UpdateContributorOrderInputFields = exports.UpdateContributorItemOrderInputFields = exports.UpdateOrderInputFields = exports.StaffTypeEnum = exports.scenarioType = exports.CreateOrderInputFields = void 0;
 const abstractRestfulClient_1 = require("../abstractRestfulClient");
 const getResult_1 = require("../getResult");
 const dataListOrders_1 = require("./entities/dataListOrders");
 const referenceLink_1 = require("./entities/referenceLink");
 const updateOrderResult_1 = require("./entities/orders/updateOrderResult");
+const attachment_1 = require("./entities/orders/attachment");
 var CreateOrderInputFields;
 (function (CreateOrderInputFields) {
     CreateOrderInputFields["COLUMN_CUSTOMER"] = "customer";
@@ -86,6 +87,11 @@ var UpdateAdditionalInformationOrderInputFields;
 (function (UpdateAdditionalInformationOrderInputFields) {
     UpdateAdditionalInformationOrderInputFields["COLUMN_DATA"] = "data";
 })(UpdateAdditionalInformationOrderInputFields = exports.UpdateAdditionalInformationOrderInputFields || (exports.UpdateAdditionalInformationOrderInputFields = {}));
+var UploadAttachmentOrderInputFields;
+(function (UploadAttachmentOrderInputFields) {
+    UploadAttachmentOrderInputFields["COLUMN_NAME"] = "name";
+    UploadAttachmentOrderInputFields["COLUMN_FILE_ENCODED"] = "fileEncoded";
+})(UploadAttachmentOrderInputFields = exports.UploadAttachmentOrderInputFields || (exports.UploadAttachmentOrderInputFields = {}));
 class OrdersClient extends abstractRestfulClient_1.AbstractRestfulClient {
     constructor() {
         super(...arguments);
@@ -138,6 +144,24 @@ class OrdersClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.path = `/${orderReference}/additionalInformation`;
         await this.patch(payload, parameters);
     }
+    async getAttachmentsOrder(orderReference, perPage, page, parameters = {}) {
+        this.path = `/${orderReference}/attachment`;
+        if (perPage) {
+            this.setPerPage(perPage);
+        }
+        if (page) {
+            this.setPage(page);
+        }
+        return new getResult_1.GetResult(attachment_1.AttachmentsListOrder, await this.get(parameters));
+    }
+    async deleteAttachmentOrder(orderReference, name, parameters = {}) {
+        this.path = `/${orderReference}/attachment/${name}`;
+        await this.delete(parameters);
+    }
+    async uploadAttachmentOrder(orderReference, payload, parameters = {}) {
+        this.path = `/${orderReference}/attachment`;
+        return new getResult_1.GetResult(attachment_1.AttachmentOrder, await this.post(payload, parameters));
+    }
 }
 exports.OrdersClient = OrdersClient;
 //# sourceMappingURL=ordersClient.js.map

package/build/organisationUnit/organizationUnitClient.d.ts

@@ -20,8 +20,8 @@ export declare class OrganizationUnitClient extends AbstractRestfulClient {
     protected basePath: string;
     getList(perPage?: number, page?: number, parameters?: Parameters): Promise<GetResult<OrganizationUnitList>>;
     create(payload: OrganizationUnitPayloadType, parameters?: Parameters): Promise<GetResult<OrganizationUnit>>;
-    getOne(organizationUnitRef: string, parameters?: Parameters): Promise<GetResult<OrganizationUnit>>;
-    update(organizationUnitRef: string, payload: OrganizationUnitPayloadType, parameters?: Parameters): Promise<GetResult<OrganizationUnit>>;
-    deleteOne(organizationUnitRef: string, parameters?: Parameters): Promise<void>;
+    getOne(ouRef: string, parameters?: Parameters): Promise<GetResult<OrganizationUnit>>;
+    update(ouRef: string, payload: OrganizationUnitPayloadType, parameters?: Parameters): Promise<GetResult<OrganizationUnit>>;
+    deleteOne(ouRef: string, parameters?: Parameters): Promise<void>;
     batchUpdate(action: OrganizationUnitClientActionFields, organizationUnitRef: string, payload: OrganizationUnitClientActionType, parameters?: Parameters): Promise<void>;
 }

package/build/organisationUnit/organizationUnitClient.js

@@ -17,7 +17,7 @@ var OrganizationUnitClientActionFields;
 class OrganizationUnitClient extends abstractRestfulClient_1.AbstractRestfulClient {
     constructor() {
         super(...arguments);
-        this.basePath = '/partners/organizationUnits';
+        this.basePath = '/organizationUnit';
     }
     async getList(perPage = 25, page = 1, parameters = {}) {
         this.setPage(page);
@@ -27,24 +27,21 @@ class OrganizationUnitClient extends abstractRestfulClient_1.AbstractRestfulClie
     async create(payload, parameters = {}) {
         return new getResult_1.GetResult(organizationUnit_1.OrganizationUnit, await this.post(payload, parameters));
     }
-    async getOne(organizationUnitRef, parameters = {}) {
-        this.path = `/${organizationUnitRef}`;
+    async getOne(ouRef, parameters = {}) {
+        this.path = `/ouRef/${ouRef}`;
         return new getResult_1.GetResult(organizationUnit_1.OrganizationUnit, await this.get(parameters));
     }
-    async update(organizationUnitRef, payload, parameters = {}) {
-        this.path = `/${organizationUnitRef}`;
+    async update(ouRef, payload, parameters = {}) {
+        this.path = `/ouRef/${ouRef}`;
         return new getResult_1.GetResult(organizationUnit_1.OrganizationUnit, await this.patch(payload, parameters));
     }
-    async deleteOne(organizationUnitRef, parameters = {}) {
-        this.path = `/${organizationUnitRef}`;
+    async deleteOne(ouRef, parameters = {}) {
+        this.path = `/ouRef/${ouRef}`;
         return await this.delete(parameters);
     }
     async batchUpdate(action, organizationUnitRef, payload, parameters = {}) {
-        this.basePath = '/organizationUnit';
         this.path = `/${action}/${organizationUnitRef}`;
-        const response = await this.patch(payload, parameters);
-        this.basePath = '/partners/organizationUnits';
-        return response;
+        return await this.patch(payload, parameters);
     }
 }
 exports.OrganizationUnitClient = OrganizationUnitClient;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "3.187.0-rc-jpb.1",
+  "version": "3.187.0-rc-cni-1",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -90,4 +90,4 @@
     "type-fest": "^2.19.0",
     "validatorjs": "3.22.1"
   }
-}
+}