@arrowsphere/api-client 3.248.2 → 3.349.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.249.0] - 2026.03.05
+
+### Added
+- [Partner] Add create, retrieve list and delete for customFields
+
 ## [3.248.2] - 2026.03.04
 
 ### Updated

package/build/partner/entities/CustomField/CustomFieldListResponse.d.ts

@@ -0,0 +1,9 @@
+import { AbstractEntity } from '../../../abstractEntity';
+import { CustomFieldResponse, CustomFieldType } from './CustomFieldResponse';
+export declare type CustomFieldListType = CustomFieldType[];
+export declare class CustomFieldListResponse extends AbstractEntity<CustomFieldListType> {
+    #private;
+    constructor(dataInput: CustomFieldListType);
+    get customFieldList(): CustomFieldResponse[];
+    toJSON(): CustomFieldListType;
+}

package/build/partner/entities/CustomField/CustomFieldListResponse.js

@@ -0,0 +1,34 @@
+"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 _CustomFieldListResponse_customFieldList;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldListResponse = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+const CustomFieldResponse_1 = require("./CustomFieldResponse");
+class CustomFieldListResponse extends abstractEntity_1.AbstractEntity {
+    constructor(dataInput) {
+        var _a;
+        super(dataInput);
+        _CustomFieldListResponse_customFieldList.set(this, void 0);
+        __classPrivateFieldSet(this, _CustomFieldListResponse_customFieldList, (_a = dataInput === null || dataInput === void 0 ? void 0 : dataInput.map((result) => new CustomFieldResponse_1.CustomFieldResponse(result))) !== null && _a !== void 0 ? _a : [], "f");
+    }
+    get customFieldList() {
+        return __classPrivateFieldGet(this, _CustomFieldListResponse_customFieldList, "f");
+    }
+    toJSON() {
+        return this.customFieldList.map((result) => result.toJSON());
+    }
+}
+exports.CustomFieldListResponse = CustomFieldListResponse;
+_CustomFieldListResponse_customFieldList = new WeakMap();
+//# sourceMappingURL=CustomFieldListResponse.js.map

package/build/partner/entities/CustomField/CustomFieldResponse.d.ts

@@ -0,0 +1,31 @@
+import { AbstractEntity } from '../../../abstractEntity';
+export declare enum CustomFieldFields {
+    COLUMN_ID = "id",
+    COLUMN_LABEL = "label",
+    COLUMN_IS_ACTIVE = "isActive",
+    COLUMN_IS_USED = "isUsed",
+    COLUMN_ENTITY = "entity",
+    COLUMN_CREATED_AT = "createdAt",
+    COLUMN_CREATED_BY = "createdBy"
+}
+export declare type CustomFieldType = {
+    [CustomFieldFields.COLUMN_ID]: number;
+    [CustomFieldFields.COLUMN_LABEL]: string;
+    [CustomFieldFields.COLUMN_IS_ACTIVE]: boolean;
+    [CustomFieldFields.COLUMN_IS_USED]: boolean;
+    [CustomFieldFields.COLUMN_ENTITY]: string;
+    [CustomFieldFields.COLUMN_CREATED_AT]: string;
+    [CustomFieldFields.COLUMN_CREATED_BY]: string;
+};
+export declare class CustomFieldResponse extends AbstractEntity<CustomFieldType> {
+    #private;
+    constructor(customFieldInput: CustomFieldType);
+    get id(): number;
+    get label(): string;
+    get isActive(): boolean;
+    get isUsed(): boolean;
+    get createdAt(): string;
+    get createdBy(): string;
+    get entity(): string;
+    toJSON(): CustomFieldType;
+}

package/build/partner/entities/CustomField/CustomFieldResponse.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 _CustomFieldResponse_id, _CustomFieldResponse_label, _CustomFieldResponse_entity, _CustomFieldResponse_isActive, _CustomFieldResponse_isUsed, _CustomFieldResponse_createdAt, _CustomFieldResponse_createdBy;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldResponse = exports.CustomFieldFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+var CustomFieldFields;
+(function (CustomFieldFields) {
+    CustomFieldFields["COLUMN_ID"] = "id";
+    CustomFieldFields["COLUMN_LABEL"] = "label";
+    CustomFieldFields["COLUMN_IS_ACTIVE"] = "isActive";
+    CustomFieldFields["COLUMN_IS_USED"] = "isUsed";
+    CustomFieldFields["COLUMN_ENTITY"] = "entity";
+    CustomFieldFields["COLUMN_CREATED_AT"] = "createdAt";
+    CustomFieldFields["COLUMN_CREATED_BY"] = "createdBy";
+})(CustomFieldFields = exports.CustomFieldFields || (exports.CustomFieldFields = {}));
+class CustomFieldResponse extends abstractEntity_1.AbstractEntity {
+    constructor(customFieldInput) {
+        super(customFieldInput);
+        _CustomFieldResponse_id.set(this, void 0);
+        _CustomFieldResponse_label.set(this, void 0);
+        _CustomFieldResponse_entity.set(this, void 0);
+        _CustomFieldResponse_isActive.set(this, void 0);
+        _CustomFieldResponse_isUsed.set(this, void 0);
+        _CustomFieldResponse_createdAt.set(this, void 0);
+        _CustomFieldResponse_createdBy.set(this, void 0);
+        __classPrivateFieldSet(this, _CustomFieldResponse_id, customFieldInput[CustomFieldFields.COLUMN_ID], "f");
+        __classPrivateFieldSet(this, _CustomFieldResponse_label, customFieldInput[CustomFieldFields.COLUMN_LABEL], "f");
+        __classPrivateFieldSet(this, _CustomFieldResponse_entity, customFieldInput[CustomFieldFields.COLUMN_ENTITY], "f");
+        __classPrivateFieldSet(this, _CustomFieldResponse_isActive, customFieldInput[CustomFieldFields.COLUMN_IS_ACTIVE], "f");
+        __classPrivateFieldSet(this, _CustomFieldResponse_isUsed, customFieldInput[CustomFieldFields.COLUMN_IS_USED], "f");
+        __classPrivateFieldSet(this, _CustomFieldResponse_createdAt, customFieldInput[CustomFieldFields.COLUMN_CREATED_AT], "f");
+        __classPrivateFieldSet(this, _CustomFieldResponse_createdBy, customFieldInput[CustomFieldFields.COLUMN_CREATED_BY], "f");
+    }
+    get id() {
+        return __classPrivateFieldGet(this, _CustomFieldResponse_id, "f");
+    }
+    get label() {
+        return __classPrivateFieldGet(this, _CustomFieldResponse_label, "f");
+    }
+    get isActive() {
+        return __classPrivateFieldGet(this, _CustomFieldResponse_isActive, "f");
+    }
+    get isUsed() {
+        return __classPrivateFieldGet(this, _CustomFieldResponse_isUsed, "f");
+    }
+    get createdAt() {
+        return __classPrivateFieldGet(this, _CustomFieldResponse_createdAt, "f");
+    }
+    get createdBy() {
+        return __classPrivateFieldGet(this, _CustomFieldResponse_createdBy, "f");
+    }
+    get entity() {
+        return __classPrivateFieldGet(this, _CustomFieldResponse_entity, "f");
+    }
+    toJSON() {
+        return {
+            [CustomFieldFields.COLUMN_ID]: this.id,
+            [CustomFieldFields.COLUMN_LABEL]: this.label,
+            [CustomFieldFields.COLUMN_ENTITY]: this.entity,
+            [CustomFieldFields.COLUMN_IS_ACTIVE]: this.isActive,
+            [CustomFieldFields.COLUMN_IS_USED]: this.isUsed,
+            [CustomFieldFields.COLUMN_CREATED_AT]: this.createdAt,
+            [CustomFieldFields.COLUMN_CREATED_BY]: this.createdBy,
+        };
+    }
+}
+exports.CustomFieldResponse = CustomFieldResponse;
+_CustomFieldResponse_id = new WeakMap(), _CustomFieldResponse_label = new WeakMap(), _CustomFieldResponse_entity = new WeakMap(), _CustomFieldResponse_isActive = new WeakMap(), _CustomFieldResponse_isUsed = new WeakMap(), _CustomFieldResponse_createdAt = new WeakMap(), _CustomFieldResponse_createdBy = new WeakMap();
+//# sourceMappingURL=CustomFieldResponse.js.map

package/build/partner/partnerClient.d.ts

@@ -6,6 +6,9 @@ import { GetUserApiKeysResult } from './types/getUserApiKeysResult';
 import { GetUserImpersonationsResult } from './types/getUserImpersonationsResult';
 import { UpdateScopeUserPayload } from './types/updateUserTypes';
 import { DataPartner } from './entities/dataPartner';
+import { createCustomFieldType } from './types/createCustomField';
+import { CustomFieldResponse } from './entities/CustomField/CustomFieldResponse';
+import { CustomFieldListResponse } from './entities/CustomField/CustomFieldListResponse';
 export declare enum PatchUserPayloadFields {
     COLUMN_FIRSTNAME = "firstname",
     COLUMN_LASTNAME = "lastname",
@@ -147,4 +150,8 @@ export declare class PartnerClient extends AbstractRestfulClient {
     getUserApiKeys(filters?: GetUserApiKeysFilters, parameters?: Parameters): Promise<GetResult<GetUserApiKeysResult>>;
     deleteUserApiKey(partnerReference: string, userReference: string, apikeyReference: string, parameters?: Parameters): Promise<void>;
     createUserApiKey(partnerReference: string, userReference: string, payload: CreateUserApiKeyPayload, parameters?: Parameters): Promise<GetResult<CreateUserApiKeyResult>>;
+    postCustomField(payload: createCustomFieldType, parameters?: Parameters): Promise<GetResult<CustomFieldResponse>>;
+    getCustomFieldList(parameters?: Parameters): Promise<GetResult<CustomFieldListResponse>>;
+    patchCustomField(customFieldId: number, isActive: boolean): Promise<GetResult<CustomFieldResponse>>;
+    deleteCustomField(customFieldId: number, parameters?: Parameters): Promise<void>;
 }

package/build/partner/partnerClient.js

@@ -8,6 +8,8 @@ const getUserApiKeysResult_1 = require("./types/getUserApiKeysResult");
 const getUserImpersonationsResult_1 = require("./types/getUserImpersonationsResult");
 const updateUserTypes_1 = require("./types/updateUserTypes");
 const dataPartner_1 = require("./entities/dataPartner");
+const CustomFieldResponse_1 = require("./entities/CustomField/CustomFieldResponse");
+const CustomFieldListResponse_1 = require("./entities/CustomField/CustomFieldListResponse");
 var PatchUserPayloadFields;
 (function (PatchUserPayloadFields) {
     PatchUserPayloadFields["COLUMN_FIRSTNAME"] = "firstname";
@@ -145,6 +147,22 @@ class PartnerClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.path = `/${partnerReference}/users/${userReference}/apikeys`;
         return new getResult_1.GetResult(createUserApiKeyResult_1.CreateUserApiKeyResult, await this.post(payload, parameters));
     }
+    async postCustomField(payload, parameters = {}) {
+        this.path = `/customField`;
+        return new getResult_1.GetResult(CustomFieldResponse_1.CustomFieldResponse, await this.post(payload, parameters));
+    }
+    async getCustomFieldList(parameters = {}) {
+        this.path = `/customField`;
+        return new getResult_1.GetResult(CustomFieldListResponse_1.CustomFieldListResponse, await this.get(parameters));
+    }
+    async patchCustomField(customFieldId, isActive) {
+        this.path = `/customField/${customFieldId}`;
+        return new getResult_1.GetResult(CustomFieldResponse_1.CustomFieldResponse, await this.patch({ isActive }));
+    }
+    async deleteCustomField(customFieldId, parameters = {}) {
+        this.path = `/customField/${customFieldId}`;
+        return this.delete(parameters);
+    }
 }
 exports.PartnerClient = PartnerClient;
 //# sourceMappingURL=partnerClient.js.map

package/build/partner/types/createCustomField.d.ts

@@ -0,0 +1,5 @@
+export declare type createCustomFieldType = {
+    label: string;
+    entity: string;
+    isActive: boolean;
+};

package/build/partner/types/createCustomField.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=createCustomField.js.map

package/package.json

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