@arrowsphere/api-client 3.193.0-rc-bdj-2 → 3.193.0

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.193.0] - 2025.05.09
+
+### Added
+- [licenses] allow to get aggregations for licenses
+
+
 ## [3.192.0] - 2025.04.29
 
 ### Added

package/build/graphqlApi/types/entities/order.d.ts

@@ -69,27 +69,3 @@ export declare type GraphqlApiOrderHistoryType = {
     order?: OrdersType;
     user?: UserType;
 };
-export declare type GraphqlApiOrderListType = {
-    id?: number;
-    country?: string;
-    createdAt?: string;
-    createdBy?: string;
-    createdByImpersonate?: string;
-    endCustomerName?: string;
-    orderType?: string;
-    partnerName?: string;
-    programName?: string;
-    partnerId?: number;
-    partnerTags?: string;
-    programId?: number;
-    reference?: string;
-    scheduledAt?: string;
-    status?: string;
-    statusId?: number;
-    totalCommitment?: number;
-    totalPrice?: number;
-    unitSymbol?: string;
-    updatedAt?: string;
-    uuid?: number;
-    vendorName?: string;
-};

package/build/graphqlApi/types/graphqlApiQueries.d.ts

@@ -3,7 +3,7 @@ import { ContactsType } from './entities/contact';
 import { GraphqlApiStaffType } from './entities/contributor';
 import { ContinentType, CountryType } from './entities/country';
 import { LicenseBudgetType } from './entities/licenseBudget';
-import { GraphqlApiOrderHistoryType, GraphqlApiOrderListType, OrdersType } from './entities/order';
+import { GraphqlApiOrderHistoryType, OrdersType } from './entities/order';
 import { OrganizationUnitsType } from './entities/organizationUnit';
 import { PartnertagType } from './entities/partnertag';
 import { GraphqlApiProgramType, ProgramLevelOptionGroupType, ProgramLevelType, SubscribedProgramType } from './entities/program';
@@ -127,7 +127,6 @@ export declare enum SelectDataField {
     ORGANIZATION_UNIT = "organizationUnit",
     ORDER = "order",
     ORDER_HISTORY = "orderHistory",
-    ORDER_LIST = "orderList",
     PARTNER = "partner",
     PARTNERTAG = "partnertag",
     PROGRAM = "program",
@@ -161,7 +160,6 @@ export declare type SelectAllResponseDataType = {
     [SelectDataField.ORGANIZATION_UNIT]?: OrganizationUnitsType[];
     [SelectDataField.ORDER]?: OrdersType[];
     [SelectDataField.ORDER_HISTORY]?: GraphqlApiOrderHistoryType[];
-    [SelectDataField.ORDER_LIST]?: GraphqlApiOrderListType[];
     [SelectDataField.PARTNER]?: PartnerType[];
     [SelectDataField.PARTNERTAG]?: PartnertagType[];
     [SelectDataField.PROGRAM]?: GraphqlApiProgramType[];

package/build/graphqlApi/types/graphqlApiQueries.js

@@ -99,7 +99,6 @@ var SelectDataField;
     SelectDataField["ORGANIZATION_UNIT"] = "organizationUnit";
     SelectDataField["ORDER"] = "order";
     SelectDataField["ORDER_HISTORY"] = "orderHistory";
-    SelectDataField["ORDER_LIST"] = "orderList";
     SelectDataField["PARTNER"] = "partner";
     SelectDataField["PARTNERTAG"] = "partnertag";
     SelectDataField["PROGRAM"] = "program";

package/build/graphqlApi/types/graphqlApiSchemas.d.ts

@@ -7,7 +7,7 @@ import { ErrorsType, PageType, Queries, SelectDataField, SelectableField } from
 import { ContactsType } from './entities/contact';
 import { SubscriptionType } from './entities/subscription';
 import { SpecialPriceRateType } from './entities/specialPriceRate';
-import { GraphqlApiOrderHistoryType, GraphqlApiOrderLinkType, GraphqlApiOrderListType, OrderItemsType, OrdersType } from './entities/order';
+import { GraphqlApiOrderHistoryType, GraphqlApiOrderLinkType, OrderItemsType, OrdersType } from './entities/order';
 import { GraphqlApiProgramType, ProgramBenefitType, ProgramLevelType, ProgramRequirementType, ProgramLevelOptionGroupType, ProgramLevelOptionType, SubscribedProgramType, SubscriptionExtraFieldType } from './entities/program';
 import { LicenseBudgetNotificationType, LicenseBudgetType } from './entities/licenseBudget';
 import { UserHistoryType, UserType } from './entities/user';
@@ -109,7 +109,6 @@ export declare type ErrorsSchema = Schema<ErrorsType, boolean>;
 export declare type GraphqlApiEavSchema = Schema<GraphqlApiEavType, boolean>;
 export declare type GraphqlApiOrderHistorySchema = Schema<GraphqlApiOrderHistoryType, boolean>;
 export declare type GraphqlApiOrderLinkSchema = Schema<GraphqlApiOrderLinkType, boolean>;
-export declare type GraphqlApiOrderListSchema = Schema<GraphqlApiOrderListType, boolean>;
 export declare type LicenseBudgetNotificationSchema = Schema<LicenseBudgetNotificationType, boolean>;
 export declare type BaseCompanySchema = Schema<BaseCompanyType, boolean>;
 export declare type OrganizationUnitSchema = Schema<OrganizationUnitsType, boolean>;

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

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

package/build/licenses/licensesClient.d.ts

@@ -32,6 +32,10 @@ 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)
      */
@@ -177,6 +181,7 @@ 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;
@@ -185,6 +190,7 @@ 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,6 +27,10 @@ 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)
      */
@@ -257,6 +261,7 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.setPerPage(perPage);
         this.setPage(page);
         const rawLicensePayload = {
+            aggregations: postData.aggregations,
             keyword: postData.keyword,
             highlight: postData.highlight,
         };
@@ -268,6 +273,14 @@ 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/package.json

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