@arrowsphere/api-client 3.195.0-rc.tbo.2 → 3.195.0

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.195.0] - 2025.05.12
+
+### Added
+- [licenses] Handle compare for endpoint find licenses v2
+
 ## [3.194.0] - 2025.05.12
 
 ### Added

package/build/licenses/licensesClient.d.ts

@@ -36,6 +36,10 @@ 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 comparisons
+     */
+    DATA_COMPARE = "compare",
     /**
      * The key for keyword search query parameter (to search one string in all available search fields)
      */
@@ -135,6 +139,9 @@ export declare type BaseParameters<LicenseType, OfferType, endCustomerOrganizati
     endCustomerOrganizationUnit?: endCustomerOrganizationUnitType;
 };
 export declare type LicenseSortParameters = BaseParameters<LicenceFindDataSortParameters, OfferFindResultDataSortParameters, EndCustomerOrganizationUnitSortParameters>;
+export declare type LicenseCompareParameters = {
+    [field: string]: unknown;
+};
 export declare type LicenseFiltersParameters = BaseParameters<LicenceFindDataFiltersParameters, OfferFindResultDataFiltersParameters, EndCustomerOrganizationUnitFiltersParameters>;
 /**
  * List of keywords to search with.
@@ -174,6 +181,9 @@ export declare type FiltersCompareValue = {
     [LicenseFindParameters.FILTERS_LTE]?: string | number;
 };
 export declare type FiltersParameters = string | string[] | number | number[] | boolean | FiltersCompareValue;
+export declare type LicenseRawCompareParameters = {
+    [field: string]: unknown;
+};
 export declare type LicenseRawFiltersParameters = {
     [field: string]: unknown;
 };
@@ -182,6 +192,7 @@ export declare type LicenseRawFiltersParameters = {
  */
 export declare type LicenseFindPayload = {
     [LicenseFindParameters.DATA_AGGREGATION]?: string[];
+    [LicenseFindParameters.DATA_COMPARE]?: LicenseCompareParameters;
     [LicenseFindParameters.DATA_KEYWORD]?: string;
     [LicenseFindParameters.DATA_KEYWORDS]?: LicenseKeywordsParameters;
     [LicenseFindParameters.DATA_FILTERS]?: LicenseFiltersParameters;
@@ -191,6 +202,7 @@ export declare type LicenseFindPayload = {
 };
 export declare type LicenseFindRawPayload = {
     [LicenseFindParameters.DATA_AGGREGATION]?: string[];
+    [LicenseFindParameters.DATA_COMPARE]?: LicenseRawCompareParameters;
     [LicenseFindParameters.DATA_KEYWORD]?: string;
     [LicenseFindParameters.DATA_KEYWORDS]?: {
         license?: LicenseRawKeywordsParametersLicence;

package/build/licenses/licensesClient.js

@@ -31,6 +31,10 @@ var 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 comparisons
+     */
+    LicenseFindParameters["DATA_COMPARE"] = "compare";
     /**
      * The key for keyword search query parameter (to search one string in all available search fields)
      */
@@ -258,6 +262,7 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
      *
      */
     async find(postData = {}, perPage = 100, page = 1, parameters = {}) {
+        var _a;
         this.setPerPage(perPage);
         this.setPage(page);
         const rawLicensePayload = {
@@ -265,6 +270,9 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
             keyword: postData.keyword,
             highlight: postData.highlight,
         };
+        if (Object.keys((_a = postData.compare) !== null && _a !== void 0 ? _a : {}).length > 0) {
+            rawLicensePayload.compare = postData.compare;
+        }
         if (postData.keywords) {
             // Flatten with prefix for each type of keyword (license and offer)
             rawLicensePayload.keywords = {

package/build/subscriptions/entities/subscriptionsListResult.d.ts

@@ -1,5 +1,5 @@
 import { AbstractEntity } from '../../abstractEntity';
-import { AdminSubscriptionsListData, SubscriptionsClient, SubscriptionsListPayload } from '../subscriptionsClient';
+import { SubscriptionsClient, SubscriptionsListData, SubscriptionsListPayload } from '../subscriptionsClient';
 import { SubscriptionData } from './subscription';
 /**
  * Subscriptions list result plain data
@@ -9,7 +9,7 @@ export declare type SubscriptionsListResultData = {
     totalPage: number;
     nbResults: number;
 };
-export declare class SubscriptionsListResult extends AbstractEntity<AdminSubscriptionsListData> {
+export declare class SubscriptionsListResult extends AbstractEntity<SubscriptionsListData> {
     #private;
     /**
      * FindResult constructor. Uses the client and request data to go through the pages.
@@ -17,7 +17,7 @@ export declare class SubscriptionsListResult extends AbstractEntity<AdminSubscri
      * @param client - Subscriptions client the call was made with
      * @param payload - Payload parameter sent to the first call
      */
-    constructor(response: AdminSubscriptionsListData, client: SubscriptionsClient, payload?: SubscriptionsListPayload);
+    constructor(response: SubscriptionsListData, client: SubscriptionsClient, payload?: SubscriptionsListPayload);
     get subscriptions(): AsyncGenerator<SubscriptionData, void, undefined>;
     get client(): SubscriptionsClient;
     get payload(): SubscriptionsListPayload;

package/build/subscriptions/subscriptionsClient.d.ts

@@ -18,7 +18,7 @@ export declare type SubscriptionsListPayload = {
     sortBy?: string;
     sortDirection?: 'ASC' | 'DESC';
 };
-export declare type AdminSubscriptionsListData = {
+export declare type SubscriptionsListData = {
     data: Array<SubscriptionData>;
     pagination: {
         perPage: number;
@@ -29,28 +29,6 @@ export declare type AdminSubscriptionsListData = {
         previous: string;
     };
 };
-export declare type PartnerSubscriptionsListData = {
-    data: Array<PartnerSubscription>;
-    status: number;
-};
-export declare type PartnerSubscription = {
-    reference: string;
-    name: string;
-    status: string;
-    dateDemand: string;
-    dateValidation: string | null;
-    dateEnd: string | null;
-    level: string | null;
-    error_msg: string | null;
-    details: {
-        partnerId: string;
-    };
-    extraInformation: {
-        programs: Record<string, {
-            partnerId: string;
-        }>;
-    };
-};
 export declare type SubscriptionCreationData = {
     name: string;
     level: string;
@@ -75,26 +53,24 @@ export declare class SubscriptionsClient extends AbstractRestfulClient {
      */
     protected isCamelPagination: boolean;
     /**
-     * @deprecated use listAdmin instead
-     * Calls the admin subscriptions API list endpoint
+     * Calls the subscriptions API list endpoint
      *
      * @param data - List payload
      *
-     * @returns Promise\<AxiosResponse\<{@link AdminSubscriptionsListData}\>\>   */
-    listRaw(data?: SubscriptionsListPayload): Promise<AdminSubscriptionsListData>;
+     * @returns Promise\<AxiosResponse\<{@link SubscriptionsListData}\>\>   */
+    listRaw(data?: SubscriptionsListPayload): Promise<SubscriptionsListData>;
     /**
      * Lists subscriptions and returns a SubscriptionsListResult to manipulate the results.
      *
      * Note: This endpoint requires an admin token to be called
      *
-     * @param filters - List payload
+     * @param postData - List payload
      * @param perPage - Number of results per page
      * @param page - Page number to fetch
      *
      * @returns Promise\<{@link SubscriptionsListResult}\>
      *
      */
-    list(filters?: SubscriptionsListPayload): Promise<PartnerSubscriptionsListData>;
-    listAdmin(filters?: SubscriptionsListPayload, perPage?: number, page?: number): Promise<SubscriptionsListResult>;
-    addSubscription(filters: SubscriptionCreationData): Promise<void>;
+    list(postData?: SubscriptionsListPayload, perPage?: number, page?: number): Promise<SubscriptionsListResult>;
+    addSubscription(postData: SubscriptionCreationData): Promise<void>;
 }

package/build/subscriptions/subscriptionsClient.js

@@ -23,12 +23,11 @@ class SubscriptionsClient extends abstractRestfulClient_1.AbstractRestfulClient
         this.isCamelPagination = true;
     }
     /**
-     * @deprecated use listAdmin instead
-     * Calls the admin subscriptions API list endpoint
+     * Calls the subscriptions API list endpoint
      *
      * @param data - List payload
      *
-     * @returns Promise\<AxiosResponse\<{@link AdminSubscriptionsListData}\>\>   */
+     * @returns Promise\<AxiosResponse\<{@link SubscriptionsListData}\>\>   */
     async listRaw(data = {}) {
         this.path = this.LIST_PATH;
         return this.get(data, {}, { isAdmin: true });
@@ -38,24 +37,21 @@ class SubscriptionsClient extends abstractRestfulClient_1.AbstractRestfulClient
      *
      * Note: This endpoint requires an admin token to be called
      *
-     * @param filters - List payload
+     * @param postData - List payload
      * @param perPage - Number of results per page
      * @param page - Page number to fetch
      *
      * @returns Promise\<{@link SubscriptionsListResult}\>
      *
      */
-    async list(filters = {}) {
-        return this.get(filters, {}, { isAdmin: false });
-    }
-    async listAdmin(filters = {}, perPage = 100, page = 1) {
+    async list(postData = {}, perPage = 100, page = 1) {
         this.setPerPage(perPage);
         this.setPage(page);
-        const response = await this.listRaw(filters);
-        return new subscriptionsListResult_1.SubscriptionsListResult(response, this, filters);
+        const response = await this.listRaw(postData);
+        return new subscriptionsListResult_1.SubscriptionsListResult(response, this, postData);
     }
-    async addSubscription(filters) {
-        return this.post(filters);
+    async addSubscription(postData) {
+        return this.post(postData);
     }
 }
 exports.SubscriptionsClient = SubscriptionsClient;

package/package.json

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