@arrowsphere/api-client 3.219.0-rc-abo-5 → 3.219.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,9 +3,9 @@
3
3
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
4
4
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5
5
 
6
- ## [3.219.0] - 2025.09.03
6
+ ## [3.219.0] - 2025.09.08
7
7
  ### Added
8
- - [license] add endpoint to get license dynamic attributes mapping
8
+ - [graphql-api] add export feature
9
9
 
10
10
  ## [3.218.0] - 2025.08.27
11
11
  ### Added
@@ -1,6 +1,6 @@
1
1
  import { AbstractGraphQLClient } from '../abstractGraphQLClient';
2
2
  import { ArrowCompanyType, EndCustomerType, PartnerType } from './types/entities/company';
3
- import { GetLocalContactResultType, GetSpecialPriceRatesHistoryResultType, InputPaginationType, InputSearchFilterType, QueryVariablesType, SelectAllQueryType, SelectAllResultType, SelectOneQueryType, SelectOneResultType } from './types/graphqlApiQueries';
3
+ import { ExportQueryType, ExportResultType, GetLocalContactResultType, GetSpecialPriceRatesHistoryResultType, InputPaginationType, InputSearchFilterType, QueryVariablesType, SelectAllQueryType, SelectAllResultType, SelectOneQueryType, SelectOneResultType } from './types/graphqlApiQueries';
4
4
  import { ArrowCompanySchema, ContactsSchema, EndCustomerSchema, PageSchema, PartnerSchema, SelectOneResponseDataSchema, SpecialPriceRateSchema } from './types/graphqlApiSchemas';
5
5
  export declare class GraphqlApiClient extends AbstractGraphQLClient {
6
6
  /**
@@ -16,4 +16,5 @@ export declare class GraphqlApiClient extends AbstractGraphQLClient {
16
16
  findArrowCompanyById(id: number, fields: ArrowCompanySchema, pagination?: InputPaginationType): Promise<ArrowCompanyType | null>;
17
17
  getLocalContact(programInternalName: string, partnerId: number, fieldSchema: ContactsSchema): Promise<GetLocalContactResultType | null>;
18
18
  getSpecialPriceRatesHistory(licenseId: number, fieldSchema: SpecialPriceRateSchema, pagination?: PageSchema, additionalParams?: QueryVariablesType): Promise<GetSpecialPriceRatesHistoryResultType | null>;
19
+ export(query: ExportQueryType): Promise<ExportResultType | null>;
19
20
  }
@@ -21,14 +21,10 @@ class GraphqlApiClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
21
21
  }
22
22
  }
23
23
  async selectAll(query) {
24
- const queryStr = this.stringifyQuery(query);
25
- const result = await this.find(queryStr);
26
- return result;
24
+ return await this.find(this.stringifyQuery(query));
27
25
  }
28
26
  async selectOne(query) {
29
- const queryStr = this.stringifyQuery(query);
30
- const result = await this.find(queryStr);
31
- return result;
27
+ return await this.find(this.stringifyQuery(query));
32
28
  }
33
29
  async findOneById(id, fieldSchema, pagination, filters, exclusionFilters) {
34
30
  var _a, _b, _c, _d, _e;
@@ -120,6 +116,9 @@ class GraphqlApiClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
120
116
  };
121
117
  return await this.find(this.stringifyQuery(query));
122
118
  }
119
+ async export(query) {
120
+ return await this.find(this.stringifyQuery(query));
121
+ }
123
122
  }
124
123
  exports.GraphqlApiClient = GraphqlApiClient;
125
124
  //# sourceMappingURL=graphqlApiClient.js.map
@@ -116,7 +116,9 @@ export declare type InputQueryOptionsType = {
116
116
  export declare enum SelectableField {
117
117
  DATA = "data",
118
118
  ERRORS = "errors",
119
- PAGINATION = "pagination"
119
+ PAGINATION = "pagination",
120
+ EXCEL_FIELDS = "excelFields",
121
+ EXPORT_TITLE = "exportTitle"
120
122
  }
121
123
  export declare enum SelectDataField {
122
124
  ARROW_COMPANY = "arrowCompany",
@@ -153,6 +155,12 @@ export declare type SelectAllResultType = {
153
155
  [SelectableField.PAGINATION]?: PageType;
154
156
  };
155
157
  };
158
+ export declare type ExportResultType = {
159
+ [Queries.EXPORT]: {
160
+ [SelectableField.DATA]?: null;
161
+ [SelectableField.ERRORS]?: ErrorsType;
162
+ };
163
+ };
156
164
  export declare type SelectAllResponseDataType = {
157
165
  [SelectDataField.ARROW_COMPANY]?: ArrowCompanyType[];
158
166
  [SelectDataField.CONTACT]?: ContactsType[];
@@ -281,6 +289,13 @@ export declare type QueryVariablesType = {
281
289
  [QueryVariablesField.SORT]?: InputSortFilterType[];
282
290
  [QueryVariablesField.OPTIONS]?: InputQueryOptionsType;
283
291
  };
292
+ export declare type QueryVariablesExportType = QueryVariablesType & {
293
+ [SelectableField.EXCEL_FIELDS]?: {
294
+ label: string;
295
+ field: string;
296
+ }[];
297
+ [SelectableField.EXPORT_TITLE]?: string;
298
+ };
284
299
  export declare type SelectOneByIdQueryVariablesType = {
285
300
  id: number;
286
301
  [QueryVariablesField.EXCLUSION_FILTERS]?: InputSearchFilterType;
@@ -292,8 +307,16 @@ export declare enum Queries {
292
307
  SELECT_ONE = "selectOne",
293
308
  SELECT_ONE_BY_ID = "selectOneById",
294
309
  GET_LOCAL_CONTACT = "getLocalContact",
295
- GET_SPECIAL_PRICE_RATES_HISTORY = "getSpecialPriceRatesHistory"
310
+ GET_SPECIAL_PRICE_RATES_HISTORY = "getSpecialPriceRatesHistory",
311
+ EXPORT = "export"
296
312
  }
313
+ export declare type ExportQueryType = {
314
+ [Queries.EXPORT]: {
315
+ __args?: QueryVariablesExportType;
316
+ [SelectableField.DATA]: SelectAllResponseDataSchema;
317
+ [SelectableField.ERRORS]?: ErrorsSchema;
318
+ };
319
+ };
297
320
  export declare type SelectAllQueryType = {
298
321
  [Queries.SELECT_ALL]: {
299
322
  __args?: QueryVariablesType;
@@ -87,6 +87,8 @@ var SelectableField;
87
87
  SelectableField["DATA"] = "data";
88
88
  SelectableField["ERRORS"] = "errors";
89
89
  SelectableField["PAGINATION"] = "pagination";
90
+ SelectableField["EXCEL_FIELDS"] = "excelFields";
91
+ SelectableField["EXPORT_TITLE"] = "exportTitle";
90
92
  })(SelectableField = exports.SelectableField || (exports.SelectableField = {}));
91
93
  var SelectDataField;
92
94
  (function (SelectDataField) {
@@ -149,5 +151,6 @@ var Queries;
149
151
  Queries["SELECT_ONE_BY_ID"] = "selectOneById";
150
152
  Queries["GET_LOCAL_CONTACT"] = "getLocalContact";
151
153
  Queries["GET_SPECIAL_PRICE_RATES_HISTORY"] = "getSpecialPriceRatesHistory";
154
+ Queries["EXPORT"] = "export";
152
155
  })(Queries = exports.Queries || (exports.Queries = {}));
153
156
  //# sourceMappingURL=graphqlApiQueries.js.map
@@ -151,6 +151,10 @@ export declare type SubscriptionSchema = Schema<SubscriptionType, boolean>;
151
151
  export declare type UserHistorySchema = Schema<UserHistoryType, boolean>;
152
152
  export declare type WorkgroupSchema = Schema<WorkgroupType, boolean>;
153
153
  export declare type SupportLevelSchema = Schema<GraphqlApiSupportLevel, boolean>;
154
+ export declare type ExportResultSchema = {
155
+ [SelectableField.DATA]?: SelectAllResponseDataSchema;
156
+ [SelectableField.ERRORS]?: ErrorsSchema;
157
+ };
154
158
  export declare type SelectAllResultSchema = {
155
159
  [SelectableField.DATA]?: SelectAllResponseDataSchema;
156
160
  [SelectableField.ERRORS]?: ErrorsSchema;
@@ -193,4 +197,7 @@ export declare type SelectAllQuerySchema = {
193
197
  export declare type SelectOneQuerySchema = {
194
198
  [Queries.SELECT_ONE]?: SelectOneResultSchema;
195
199
  };
200
+ export declare type ExportQuerySchema = {
201
+ [Queries.EXPORT]?: ExportResultSchema;
202
+ };
196
203
  export {};
@@ -61,8 +61,7 @@ export declare enum LicenseFindResultFields {
61
61
  COLUMN_VENDOR_CODE = "vendor_code",
62
62
  COLUMN_VENDOR_NAME = "vendor_name",
63
63
  COLUMN_VENDOR_SUBSCRIPTION_ID = "vendor_subscription_id",
64
- COLUMN_HIGHLIGHT = "highlight",
65
- COLUMN_ATTRIBUTES = "attributes"
64
+ COLUMN_HIGHLIGHT = "highlight"
66
65
  }
67
66
  /**
68
67
  * License data fields and their corresponding types
@@ -114,7 +113,6 @@ export declare type LicenseFindResultData = {
114
113
  [LicenseFindResultFields.COLUMN_VENDOR_NAME]: string;
115
114
  [LicenseFindResultFields.COLUMN_VENDOR_SUBSCRIPTION_ID]: string | null;
116
115
  [LicenseFindResultFields.COLUMN_HIGHLIGHT]?: Highlight;
117
- [LicenseFindResultFields.COLUMN_ATTRIBUTES]?: Record<string, string>;
118
116
  };
119
117
  export declare type LicenceFindDataKeywords = {
120
118
  [LicenseFindResultFields.COLUMN_ACCEPT_EULA]?: DataKeywords;
@@ -70,7 +70,6 @@ var LicenseFindResultFields;
70
70
  LicenseFindResultFields["COLUMN_VENDOR_NAME"] = "vendor_name";
71
71
  LicenseFindResultFields["COLUMN_VENDOR_SUBSCRIPTION_ID"] = "vendor_subscription_id";
72
72
  LicenseFindResultFields["COLUMN_HIGHLIGHT"] = "highlight";
73
- LicenseFindResultFields["COLUMN_ATTRIBUTES"] = "attributes";
74
73
  })(LicenseFindResultFields = exports.LicenseFindResultFields || (exports.LicenseFindResultFields = {}));
75
74
  class LicenseFindResult extends abstractEntity_1.AbstractEntity {
76
75
  /**
@@ -49,4 +49,3 @@ export * from './licenseRequestClient';
49
49
  export * from './licensesClient';
50
50
  export * from './licensesEventClient';
51
51
  export * from './types/bulkArguments';
52
- export * from './entities/license/dynamicMappingResult';
@@ -65,5 +65,4 @@ __exportStar(require("./licenseRequestClient"), exports);
65
65
  __exportStar(require("./licensesClient"), exports);
66
66
  __exportStar(require("./licensesEventClient"), exports);
67
67
  __exportStar(require("./types/bulkArguments"), exports);
68
- __exportStar(require("./entities/license/dynamicMappingResult"), exports);
69
68
  //# sourceMappingURL=index.js.map
@@ -28,7 +28,6 @@ import { ConsumptionDailyPrediction } from '../consumption';
28
28
  import { GetScheduledTasksResult } from './entities/schedule/getScheduledTasksResult';
29
29
  import { GetScheduleTaskResult } from './entities/schedule/getScheduleTaskResult';
30
30
  import { LicenceCouponCodeHistoryResult } from './entities/history/licenceCouponCodeHistoryResult';
31
- import { DynamicAttributesMappingResult } from './entities/license/dynamicMappingResult';
32
31
  /**
33
32
  * Parameters passable to the request for refining search.
34
33
  */
@@ -433,5 +432,4 @@ export declare class LicensesClient extends AbstractRestfulClient {
433
432
  rewriteRateHistory(licenseReference: string, payload: RewriteRateHistoryInputType, parameters?: Parameters): Promise<void>;
434
433
  private createFilters;
435
434
  private createKeywords;
436
- getLicenseDynamicAttributesMapping(parameters?: Parameters): Promise<GetResult<DynamicAttributesMappingResult>>;
437
435
  }
@@ -22,7 +22,6 @@ const consumption_1 = require("../consumption");
22
22
  const getScheduledTasksResult_1 = require("./entities/schedule/getScheduledTasksResult");
23
23
  const getScheduleTaskResult_1 = require("./entities/schedule/getScheduleTaskResult");
24
24
  const licenceCouponCodeHistoryResult_1 = require("./entities/history/licenceCouponCodeHistoryResult");
25
- const dynamicMappingResult_1 = require("./entities/license/dynamicMappingResult");
26
25
  /**
27
26
  * Parameters passable to the request for refining search.
28
27
  */
@@ -571,10 +570,6 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
571
570
  return acc;
572
571
  }, {});
573
572
  }
574
- async getLicenseDynamicAttributesMapping(parameters = {}) {
575
- this.path = '/license-mapping';
576
- return new getResult_1.GetResult(dynamicMappingResult_1.DynamicAttributesMappingResult, await this.get(parameters));
577
- }
578
573
  }
579
574
  exports.LicensesClient = LicensesClient;
580
575
  //# sourceMappingURL=licensesClient.js.map
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "type": "git",
5
5
  "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
6
6
  },
7
- "version": "3.219.0-rc-abo-5",
7
+ "version": "3.219.0",
8
8
  "description": "Node.js client for ArrowSphere's public API",
9
9
  "main": "build/index.js",
10
10
  "types": "build/index.d.ts",
@@ -1,8 +0,0 @@
1
- import { AbstractEntity } from '../../../abstractEntity';
2
- export declare type DynamicAttributesMappingResultData = {
3
- [key: string]: string;
4
- };
5
- export declare class DynamicAttributesMappingResult extends AbstractEntity<DynamicAttributesMappingResultData> {
6
- constructor(data: DynamicAttributesMappingResultData);
7
- toJSON(): DynamicAttributesMappingResultData;
8
- }
@@ -1,14 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DynamicAttributesMappingResult = void 0;
4
- const abstractEntity_1 = require("../../../abstractEntity");
5
- class DynamicAttributesMappingResult extends abstractEntity_1.AbstractEntity {
6
- constructor(data) {
7
- super(data);
8
- }
9
- toJSON() {
10
- return this.entityDataInput;
11
- }
12
- }
13
- exports.DynamicAttributesMappingResult = DynamicAttributesMappingResult;
14
- //# sourceMappingURL=dynamicMappingResult.js.map