@arrowsphere/api-client 3.357.0-rc-cpe-2 → 3.357.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,6 +3,20 @@
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.357.0] - 2026.04.08
7
+
8
+ ### Added
9
+ - [Partner] Add `CustomFieldEntityEnum` with values `COMPANY` and `ORDER_ITEM`
10
+ - [Partner] Add `entity` path param to `getCustomFieldList`
11
+ - [Partner] Add `entity` path param to `postCustomField`
12
+ - [Partner] Add query filters to `getCustomFieldList`
13
+
14
+ ### Updated
15
+ - [Partner] Fix `getCustomFieldList` path to `/customField/entity/{entity}`
16
+ - [Partner] Fix `postCustomField` path to `/customField/entity/{entity}`
17
+ - [Partner] Fix `patchCustomField` path to `/customField/customFieldId/{customFieldId}`
18
+ - [Partner] Fix `deleteCustomField` path to `/customField/customFieldId/{customFieldId}`
19
+
6
20
  ## [3.356.0] - 2026.03.30
7
21
 
8
22
  ### Added
@@ -19,7 +19,6 @@ export declare type QuoteType = {
19
19
  items?: QuoteItemType[];
20
20
  name?: string;
21
21
  partner?: PartnerType;
22
- partnerContact?: ContactsType;
23
22
  versions?: QuoteVersion[];
24
23
  promotionCode?: string;
25
24
  promotionType?: string;
@@ -68,8 +68,10 @@ declare type MissingFieldsOfLicenseBudgetSchema = {
68
68
  };
69
69
  declare type MissingFieldsOfQuoteSchema = {
70
70
  arrowCompany?: ArrowCompanySchema;
71
+ endCustomer?: EndCustomerSchema;
71
72
  comments?: CommentSchema;
72
73
  items?: QuoteItemSchema;
74
+ partner?: PartnerSchema;
73
75
  versions?: QuoteVersionSchema;
74
76
  lastVersion?: QuoteVersionSchema;
75
77
  };
@@ -44,8 +44,7 @@ export declare enum CreateOrderInputFields {
44
44
  COLUMN_COTERMINOSITY_SUBSCRIPTION_REF = "coterminositySubscriptionRef",
45
45
  COLUMN_PROMOTION_ID = "promotionId",
46
46
  COLUMN_ORGANIZATION_UNIT_REF = "organizationUnitRef",
47
- COLUMN_EAVS = "eavs",
48
- COLUMN_QUOTE_REF = "quoteRef"
47
+ COLUMN_EAVS = "eavs"
49
48
  }
50
49
  export declare enum scenarioType {
51
50
  INJECTION = "injection",
@@ -77,7 +76,6 @@ export declare type CreateOrderInputType = {
77
76
  programs: OrderProgramsType;
78
77
  };
79
78
  [CreateOrderInputFields.COLUMN_ORGANIZATION_UNIT_REF]?: string;
80
- [CreateOrderInputFields.COLUMN_QUOTE_REF]?: string;
81
79
  };
82
80
  export declare type CreateOrderProductType = {
83
81
  [CreateOrderInputFields.COLUMN_ARROW_SPHERE_PRICE_BAND_SKU]?: string;
@@ -49,7 +49,6 @@ var CreateOrderInputFields;
49
49
  CreateOrderInputFields["COLUMN_PROMOTION_ID"] = "promotionId";
50
50
  CreateOrderInputFields["COLUMN_ORGANIZATION_UNIT_REF"] = "organizationUnitRef";
51
51
  CreateOrderInputFields["COLUMN_EAVS"] = "eavs";
52
- CreateOrderInputFields["COLUMN_QUOTE_REF"] = "quoteRef";
53
52
  })(CreateOrderInputFields = exports.CreateOrderInputFields || (exports.CreateOrderInputFields = {}));
54
53
  var scenarioType;
55
54
  (function (scenarioType) {
@@ -2,8 +2,11 @@ export * from './partnerClient';
2
2
  export * from './types/getUserImpersonationsResult';
3
3
  export * from './types/updateUserTypes';
4
4
  export * from './types/userImpersonation';
5
+ export * from './types/createCustomField';
5
6
  export * from './entities/dataPartner';
6
7
  export * from './entities/company/company';
7
8
  export * from './entities/company/address/address';
8
9
  export * from './entities/contact/contact';
9
10
  export * from './entities/user/user';
11
+ export * from './entities/CustomField/CustomFieldResponse';
12
+ export * from './entities/CustomField/CustomFieldListResponse';
@@ -18,9 +18,12 @@ __exportStar(require("./partnerClient"), exports);
18
18
  __exportStar(require("./types/getUserImpersonationsResult"), exports);
19
19
  __exportStar(require("./types/updateUserTypes"), exports);
20
20
  __exportStar(require("./types/userImpersonation"), exports);
21
+ __exportStar(require("./types/createCustomField"), exports);
21
22
  __exportStar(require("./entities/dataPartner"), exports);
22
23
  __exportStar(require("./entities/company/company"), exports);
23
24
  __exportStar(require("./entities/company/address/address"), exports);
24
25
  __exportStar(require("./entities/contact/contact"), exports);
25
26
  __exportStar(require("./entities/user/user"), exports);
27
+ __exportStar(require("./entities/CustomField/CustomFieldResponse"), exports);
28
+ __exportStar(require("./entities/CustomField/CustomFieldListResponse"), exports);
26
29
  //# sourceMappingURL=index.js.map
@@ -6,7 +6,7 @@ import { GetUserApiKeysResult } from './types/getUserApiKeysResult';
6
6
  import { GetUserImpersonationsResult } from './types/getUserImpersonationsResult';
7
7
  import { UpdateScopeUserPayload } from './types/updateUserTypes';
8
8
  import { DataPartner } from './entities/dataPartner';
9
- import { createCustomFieldType } from './types/createCustomField';
9
+ import { createCustomFieldType, CustomFieldEntityEnum } from './types/createCustomField';
10
10
  import { CustomFieldResponse } from './entities/CustomField/CustomFieldResponse';
11
11
  import { CustomFieldListResponse } from './entities/CustomField/CustomFieldListResponse';
12
12
  export declare enum PatchUserPayloadFields {
@@ -138,6 +138,36 @@ export declare type GetUserApiKeysFilters = {
138
138
  export declare type CustomerListPayload = {
139
139
  [PostAttachmentFields.COLUMN_FILE_ENCODED]: string;
140
140
  };
141
+ export declare enum GetCustomFieldListFiltersFields {
142
+ COLUMN_LABEL = "label",
143
+ COLUMN_IS_ACTIVE = "isActive",
144
+ COLUMN_CREATED_BY = "createdBy",
145
+ COLUMN_CREATED_AT = "createdAt",
146
+ COLUMN_PAGE = "page",
147
+ COLUMN_PER_PAGE = "per_page",
148
+ COLUMN_SORT_BY = "sort_by",
149
+ COLUMN_ORDER_BY = "order_by"
150
+ }
151
+ export declare enum CustomFieldSortByEnum {
152
+ LABEL = "label",
153
+ CREATED_AT = "createdAt",
154
+ CREATED_BY = "createdBy",
155
+ IS_ACTIVE = "isActive"
156
+ }
157
+ export declare enum CustomFieldOrderByEnum {
158
+ ASC = "ASC",
159
+ DESC = "DESC"
160
+ }
161
+ export declare type GetCustomFieldListFilters = {
162
+ [GetCustomFieldListFiltersFields.COLUMN_LABEL]?: string;
163
+ [GetCustomFieldListFiltersFields.COLUMN_IS_ACTIVE]?: boolean;
164
+ [GetCustomFieldListFiltersFields.COLUMN_CREATED_BY]?: string;
165
+ [GetCustomFieldListFiltersFields.COLUMN_CREATED_AT]?: string;
166
+ [GetCustomFieldListFiltersFields.COLUMN_PAGE]?: number;
167
+ [GetCustomFieldListFiltersFields.COLUMN_PER_PAGE]?: number;
168
+ [GetCustomFieldListFiltersFields.COLUMN_SORT_BY]?: CustomFieldSortByEnum;
169
+ [GetCustomFieldListFiltersFields.COLUMN_ORDER_BY]?: CustomFieldOrderByEnum;
170
+ };
141
171
  export declare class PartnerClient extends AbstractRestfulClient {
142
172
  protected basePath: string;
143
173
  deletePartner(partnerReference: string, parameters?: Parameters): Promise<void>;
@@ -156,9 +186,9 @@ export declare class PartnerClient extends AbstractRestfulClient {
156
186
  getUserApiKeys(filters?: GetUserApiKeysFilters, parameters?: Parameters): Promise<GetResult<GetUserApiKeysResult>>;
157
187
  deleteUserApiKey(partnerReference: string, userReference: string, apikeyReference: string, parameters?: Parameters): Promise<void>;
158
188
  createUserApiKey(partnerReference: string, userReference: string, payload: CreateUserApiKeyPayload, parameters?: Parameters): Promise<GetResult<CreateUserApiKeyResult>>;
159
- postCustomField(payload: createCustomFieldType, parameters?: Parameters): Promise<GetResult<CustomFieldResponse>>;
160
- getCustomFieldList(parameters?: Parameters): Promise<GetResult<CustomFieldListResponse>>;
161
- patchCustomField(customFieldId: number, isActive: boolean): Promise<GetResult<CustomFieldResponse>>;
189
+ postCustomField(entity: CustomFieldEntityEnum, payload: createCustomFieldType, parameters?: Parameters): Promise<GetResult<CustomFieldResponse>>;
190
+ getCustomFieldList(entity: CustomFieldEntityEnum, filters?: GetCustomFieldListFilters, parameters?: Parameters): Promise<GetResult<CustomFieldListResponse>>;
191
+ patchCustomField(customFieldId: number, isActive: boolean, parameters?: Parameters): Promise<GetResult<CustomFieldResponse>>;
162
192
  deleteCustomField(customFieldId: number, parameters?: Parameters): Promise<void>;
163
193
  generateGdapLinksFromCustomerListFile(payload: CustomerListPayload): Promise<void>;
164
194
  }
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PartnerClient = exports.PostAttachmentFields = exports.GetUserApiKeysFiltersFields = exports.PartnerCompanyPayloadFields = exports.PartnerAddressFields = exports.PartnerContactPayloadFields = exports.PartnerUserPayloadFields = exports.PartnerFields = exports.PatchUserPayloadFields = void 0;
3
+ exports.PartnerClient = exports.CustomFieldOrderByEnum = exports.CustomFieldSortByEnum = exports.GetCustomFieldListFiltersFields = exports.PostAttachmentFields = exports.GetUserApiKeysFiltersFields = exports.PartnerCompanyPayloadFields = exports.PartnerAddressFields = exports.PartnerContactPayloadFields = exports.PartnerUserPayloadFields = exports.PartnerFields = exports.PatchUserPayloadFields = void 0;
4
4
  const abstractRestfulClient_1 = require("../abstractRestfulClient");
5
5
  const createUserApiKeyResult_1 = require("./types/createUserApiKeyResult");
6
6
  const getResult_1 = require("../getResult");
@@ -83,6 +83,29 @@ var PostAttachmentFields;
83
83
  (function (PostAttachmentFields) {
84
84
  PostAttachmentFields["COLUMN_FILE_ENCODED"] = "fileEncoded";
85
85
  })(PostAttachmentFields = exports.PostAttachmentFields || (exports.PostAttachmentFields = {}));
86
+ var GetCustomFieldListFiltersFields;
87
+ (function (GetCustomFieldListFiltersFields) {
88
+ GetCustomFieldListFiltersFields["COLUMN_LABEL"] = "label";
89
+ GetCustomFieldListFiltersFields["COLUMN_IS_ACTIVE"] = "isActive";
90
+ GetCustomFieldListFiltersFields["COLUMN_CREATED_BY"] = "createdBy";
91
+ GetCustomFieldListFiltersFields["COLUMN_CREATED_AT"] = "createdAt";
92
+ GetCustomFieldListFiltersFields["COLUMN_PAGE"] = "page";
93
+ GetCustomFieldListFiltersFields["COLUMN_PER_PAGE"] = "per_page";
94
+ GetCustomFieldListFiltersFields["COLUMN_SORT_BY"] = "sort_by";
95
+ GetCustomFieldListFiltersFields["COLUMN_ORDER_BY"] = "order_by";
96
+ })(GetCustomFieldListFiltersFields = exports.GetCustomFieldListFiltersFields || (exports.GetCustomFieldListFiltersFields = {}));
97
+ var CustomFieldSortByEnum;
98
+ (function (CustomFieldSortByEnum) {
99
+ CustomFieldSortByEnum["LABEL"] = "label";
100
+ CustomFieldSortByEnum["CREATED_AT"] = "createdAt";
101
+ CustomFieldSortByEnum["CREATED_BY"] = "createdBy";
102
+ CustomFieldSortByEnum["IS_ACTIVE"] = "isActive";
103
+ })(CustomFieldSortByEnum = exports.CustomFieldSortByEnum || (exports.CustomFieldSortByEnum = {}));
104
+ var CustomFieldOrderByEnum;
105
+ (function (CustomFieldOrderByEnum) {
106
+ CustomFieldOrderByEnum["ASC"] = "ASC";
107
+ CustomFieldOrderByEnum["DESC"] = "DESC";
108
+ })(CustomFieldOrderByEnum = exports.CustomFieldOrderByEnum || (exports.CustomFieldOrderByEnum = {}));
86
109
  class PartnerClient extends abstractRestfulClient_1.AbstractRestfulClient {
87
110
  constructor() {
88
111
  super(...arguments);
@@ -151,20 +174,24 @@ class PartnerClient extends abstractRestfulClient_1.AbstractRestfulClient {
151
174
  this.path = `/${partnerReference}/users/${userReference}/apikeys`;
152
175
  return new getResult_1.GetResult(createUserApiKeyResult_1.CreateUserApiKeyResult, await this.post(payload, parameters));
153
176
  }
154
- async postCustomField(payload, parameters = {}) {
155
- this.path = `/customField`;
177
+ async postCustomField(entity, payload, parameters = {}) {
178
+ this.path = `/customField/entity/${entity}`;
156
179
  return new getResult_1.GetResult(CustomFieldResponse_1.CustomFieldResponse, await this.post(payload, parameters));
157
180
  }
158
- async getCustomFieldList(parameters = {}) {
159
- this.path = `/customField`;
160
- return new getResult_1.GetResult(CustomFieldListResponse_1.CustomFieldListResponse, await this.get(parameters));
181
+ async getCustomFieldList(entity, filters = {}, parameters = {}) {
182
+ this.path = `/customField/entity/${entity}`;
183
+ const queryParameters = {
184
+ ...parameters,
185
+ ...filters,
186
+ };
187
+ return new getResult_1.GetResult(CustomFieldListResponse_1.CustomFieldListResponse, await this.get(queryParameters));
161
188
  }
162
- async patchCustomField(customFieldId, isActive) {
163
- this.path = `/customField/${customFieldId}`;
164
- return new getResult_1.GetResult(CustomFieldResponse_1.CustomFieldResponse, await this.patch({ isActive }));
189
+ async patchCustomField(customFieldId, isActive, parameters = {}) {
190
+ this.path = `/customField/customFieldId/${customFieldId}`;
191
+ return new getResult_1.GetResult(CustomFieldResponse_1.CustomFieldResponse, await this.patch({ isActive }, parameters));
165
192
  }
166
193
  async deleteCustomField(customFieldId, parameters = {}) {
167
- this.path = `/customField/${customFieldId}`;
194
+ this.path = `/customField/customFieldId/${customFieldId}`;
168
195
  return this.delete(parameters);
169
196
  }
170
197
  async generateGdapLinksFromCustomerListFile(payload) {
@@ -1,5 +1,9 @@
1
+ export declare enum CustomFieldEntityEnum {
2
+ COMPANY = "COMPANY",
3
+ ORDER_ITEM = "ORDER_ITEM"
4
+ }
1
5
  export declare type createCustomFieldType = {
2
6
  label: string;
3
- entity: string;
7
+ entity: CustomFieldEntityEnum;
4
8
  isActive: boolean;
5
9
  };
@@ -1,3 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CustomFieldEntityEnum = void 0;
4
+ var CustomFieldEntityEnum;
5
+ (function (CustomFieldEntityEnum) {
6
+ CustomFieldEntityEnum["COMPANY"] = "COMPANY";
7
+ CustomFieldEntityEnum["ORDER_ITEM"] = "ORDER_ITEM";
8
+ })(CustomFieldEntityEnum = exports.CustomFieldEntityEnum || (exports.CustomFieldEntityEnum = {}));
3
9
  //# sourceMappingURL=createCustomField.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.357.0-rc-cpe-2",
7
+ "version": "3.357.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",