@arrowsphere/api-client 3.240.0 → 3.241.0-rc-jpb.4

package/build/licenses/entities/attachment/GetLicenseAttachmentResult.d.ts

@@ -0,0 +1,22 @@
+import { AbstractEntity } from '../../../abstractEntity';
+export declare enum GetLicenseAttachmentResultFields {
+    COLUMN_NAME = "name",
+    COLUMN_LAST_MODIFIED = "lastModified",
+    COLUMN_URL = "url",
+    COLUMN_METADATA = "metadata"
+}
+export declare type GetLicenseAttachmentResultData = {
+    [GetLicenseAttachmentResultFields.COLUMN_NAME]: string;
+    [GetLicenseAttachmentResultFields.COLUMN_LAST_MODIFIED]: string;
+    [GetLicenseAttachmentResultFields.COLUMN_URL]: string;
+    [GetLicenseAttachmentResultFields.COLUMN_METADATA]?: Record<string, string>;
+};
+export declare class GetLicenseAttachmentResult extends AbstractEntity<GetLicenseAttachmentResultData> {
+    #private;
+    constructor(input: GetLicenseAttachmentResultData);
+    get name(): string;
+    get lastModified(): string;
+    get url(): string;
+    get metadata(): Record<string, string> | undefined;
+    toJSON(): GetLicenseAttachmentResultData;
+}

package/build/licenses/entities/attachment/GetLicenseAttachmentResult.js

@@ -0,0 +1,60 @@
+"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 _GetLicenseAttachmentResult_name, _GetLicenseAttachmentResult_lastModified, _GetLicenseAttachmentResult_url, _GetLicenseAttachmentResult_metadata;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetLicenseAttachmentResult = exports.GetLicenseAttachmentResultFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+var GetLicenseAttachmentResultFields;
+(function (GetLicenseAttachmentResultFields) {
+    GetLicenseAttachmentResultFields["COLUMN_NAME"] = "name";
+    GetLicenseAttachmentResultFields["COLUMN_LAST_MODIFIED"] = "lastModified";
+    GetLicenseAttachmentResultFields["COLUMN_URL"] = "url";
+    GetLicenseAttachmentResultFields["COLUMN_METADATA"] = "metadata";
+})(GetLicenseAttachmentResultFields = exports.GetLicenseAttachmentResultFields || (exports.GetLicenseAttachmentResultFields = {}));
+class GetLicenseAttachmentResult extends abstractEntity_1.AbstractEntity {
+    constructor(input) {
+        super(input);
+        _GetLicenseAttachmentResult_name.set(this, void 0);
+        _GetLicenseAttachmentResult_lastModified.set(this, void 0);
+        _GetLicenseAttachmentResult_url.set(this, void 0);
+        _GetLicenseAttachmentResult_metadata.set(this, void 0);
+        __classPrivateFieldSet(this, _GetLicenseAttachmentResult_name, input[GetLicenseAttachmentResultFields.COLUMN_NAME], "f");
+        __classPrivateFieldSet(this, _GetLicenseAttachmentResult_lastModified, input[GetLicenseAttachmentResultFields.COLUMN_LAST_MODIFIED], "f");
+        __classPrivateFieldSet(this, _GetLicenseAttachmentResult_url, input[GetLicenseAttachmentResultFields.COLUMN_URL], "f");
+        __classPrivateFieldSet(this, _GetLicenseAttachmentResult_metadata, input[GetLicenseAttachmentResultFields.COLUMN_METADATA], "f");
+    }
+    get name() {
+        return __classPrivateFieldGet(this, _GetLicenseAttachmentResult_name, "f");
+    }
+    get lastModified() {
+        return __classPrivateFieldGet(this, _GetLicenseAttachmentResult_lastModified, "f");
+    }
+    get url() {
+        return __classPrivateFieldGet(this, _GetLicenseAttachmentResult_url, "f");
+    }
+    get metadata() {
+        return __classPrivateFieldGet(this, _GetLicenseAttachmentResult_metadata, "f");
+    }
+    toJSON() {
+        return {
+            [GetLicenseAttachmentResultFields.COLUMN_NAME]: this.name,
+            [GetLicenseAttachmentResultFields.COLUMN_LAST_MODIFIED]: this
+                .lastModified,
+            [GetLicenseAttachmentResultFields.COLUMN_URL]: this.url,
+            [GetLicenseAttachmentResultFields.COLUMN_METADATA]: this.metadata,
+        };
+    }
+}
+exports.GetLicenseAttachmentResult = GetLicenseAttachmentResult;
+_GetLicenseAttachmentResult_name = new WeakMap(), _GetLicenseAttachmentResult_lastModified = new WeakMap(), _GetLicenseAttachmentResult_url = new WeakMap(), _GetLicenseAttachmentResult_metadata = new WeakMap();
+//# sourceMappingURL=GetLicenseAttachmentResult.js.map

package/build/licenses/entities/attachment/GetLicenseAttachmentsResult.d.ts

@@ -0,0 +1,14 @@
+import { AbstractEntity } from '../../../abstractEntity';
+import { GetLicenseAttachmentResult, GetLicenseAttachmentResultData } from './GetLicenseAttachmentResult';
+export declare enum GetLicenseAttachmentsResultFields {
+    COLUMN_ATTACHMENTS = "attachements"
+}
+export declare type GetLicenseAttachmentsResultData = {
+    [GetLicenseAttachmentsResultFields.COLUMN_ATTACHMENTS]: GetLicenseAttachmentResultData[];
+};
+export declare class GetLicenseAttachmentsResult extends AbstractEntity<GetLicenseAttachmentsResultData> {
+    #private;
+    constructor(input: GetLicenseAttachmentsResultData);
+    getLicenseAttachments(): GetLicenseAttachmentResult[];
+    toJSON(): GetLicenseAttachmentsResultData;
+}

package/build/licenses/entities/attachment/GetLicenseAttachmentsResult.js

@@ -0,0 +1,39 @@
+"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 _GetLicenseAttachmentsResult_attachments;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetLicenseAttachmentsResult = exports.GetLicenseAttachmentsResultFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+const GetLicenseAttachmentResult_1 = require("./GetLicenseAttachmentResult");
+var GetLicenseAttachmentsResultFields;
+(function (GetLicenseAttachmentsResultFields) {
+    GetLicenseAttachmentsResultFields["COLUMN_ATTACHMENTS"] = "attachements";
+})(GetLicenseAttachmentsResultFields = exports.GetLicenseAttachmentsResultFields || (exports.GetLicenseAttachmentsResultFields = {}));
+class GetLicenseAttachmentsResult extends abstractEntity_1.AbstractEntity {
+    constructor(input) {
+        super(input);
+        _GetLicenseAttachmentsResult_attachments.set(this, void 0);
+        __classPrivateFieldSet(this, _GetLicenseAttachmentsResult_attachments, input[GetLicenseAttachmentsResultFields.COLUMN_ATTACHMENTS].map((result) => new GetLicenseAttachmentResult_1.GetLicenseAttachmentResult(result)), "f");
+    }
+    getLicenseAttachments() {
+        return __classPrivateFieldGet(this, _GetLicenseAttachmentsResult_attachments, "f");
+    }
+    toJSON() {
+        return {
+            [GetLicenseAttachmentsResultFields.COLUMN_ATTACHMENTS]: __classPrivateFieldGet(this, _GetLicenseAttachmentsResult_attachments, "f").map((result) => result.toJSON()),
+        };
+    }
+}
+exports.GetLicenseAttachmentsResult = GetLicenseAttachmentsResult;
+_GetLicenseAttachmentsResult_attachments = new WeakMap();
+//# sourceMappingURL=GetLicenseAttachmentsResult.js.map

package/build/licenses/entities/attachment/PostLicenseAttachmentResult.d.ts

@@ -0,0 +1,22 @@
+import { AbstractEntity } from '../../../abstractEntity';
+export declare enum PostLicenseAttachmentResultFields {
+    COLUMN_NAME = "name",
+    COLUMN_LAST_MODIFIED = "lastModified",
+    COLUMN_URL = "url",
+    COLUMN_METADATA = "metadata"
+}
+export declare type PostLicenseAttachmentResultData = {
+    [PostLicenseAttachmentResultFields.COLUMN_NAME]: string;
+    [PostLicenseAttachmentResultFields.COLUMN_LAST_MODIFIED]: string;
+    [PostLicenseAttachmentResultFields.COLUMN_URL]: string;
+    [PostLicenseAttachmentResultFields.COLUMN_METADATA]?: Record<string, string>;
+};
+export declare class PostLicenseAttachmentResult extends AbstractEntity<PostLicenseAttachmentResultData> {
+    #private;
+    constructor(input: PostLicenseAttachmentResultData);
+    get name(): string;
+    get lastModified(): string;
+    get url(): string;
+    get metadata(): Record<string, string> | undefined;
+    toJSON(): PostLicenseAttachmentResultData;
+}

package/build/licenses/entities/attachment/PostLicenseAttachmentResult.js

@@ -0,0 +1,60 @@
+"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 _PostLicenseAttachmentResult_name, _PostLicenseAttachmentResult_lastModified, _PostLicenseAttachmentResult_url, _PostLicenseAttachmentResult_metadata;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostLicenseAttachmentResult = exports.PostLicenseAttachmentResultFields = void 0;
+const abstractEntity_1 = require("../../../abstractEntity");
+var PostLicenseAttachmentResultFields;
+(function (PostLicenseAttachmentResultFields) {
+    PostLicenseAttachmentResultFields["COLUMN_NAME"] = "name";
+    PostLicenseAttachmentResultFields["COLUMN_LAST_MODIFIED"] = "lastModified";
+    PostLicenseAttachmentResultFields["COLUMN_URL"] = "url";
+    PostLicenseAttachmentResultFields["COLUMN_METADATA"] = "metadata";
+})(PostLicenseAttachmentResultFields = exports.PostLicenseAttachmentResultFields || (exports.PostLicenseAttachmentResultFields = {}));
+class PostLicenseAttachmentResult extends abstractEntity_1.AbstractEntity {
+    constructor(input) {
+        super(input);
+        _PostLicenseAttachmentResult_name.set(this, void 0);
+        _PostLicenseAttachmentResult_lastModified.set(this, void 0);
+        _PostLicenseAttachmentResult_url.set(this, void 0);
+        _PostLicenseAttachmentResult_metadata.set(this, void 0);
+        __classPrivateFieldSet(this, _PostLicenseAttachmentResult_name, input[PostLicenseAttachmentResultFields.COLUMN_NAME], "f");
+        __classPrivateFieldSet(this, _PostLicenseAttachmentResult_lastModified, input[PostLicenseAttachmentResultFields.COLUMN_LAST_MODIFIED], "f");
+        __classPrivateFieldSet(this, _PostLicenseAttachmentResult_url, input[PostLicenseAttachmentResultFields.COLUMN_URL], "f");
+        __classPrivateFieldSet(this, _PostLicenseAttachmentResult_metadata, input[PostLicenseAttachmentResultFields.COLUMN_METADATA], "f");
+    }
+    get name() {
+        return __classPrivateFieldGet(this, _PostLicenseAttachmentResult_name, "f");
+    }
+    get lastModified() {
+        return __classPrivateFieldGet(this, _PostLicenseAttachmentResult_lastModified, "f");
+    }
+    get url() {
+        return __classPrivateFieldGet(this, _PostLicenseAttachmentResult_url, "f");
+    }
+    get metadata() {
+        return __classPrivateFieldGet(this, _PostLicenseAttachmentResult_metadata, "f");
+    }
+    toJSON() {
+        return {
+            [PostLicenseAttachmentResultFields.COLUMN_NAME]: this.name,
+            [PostLicenseAttachmentResultFields.COLUMN_LAST_MODIFIED]: this
+                .lastModified,
+            [PostLicenseAttachmentResultFields.COLUMN_URL]: this.url,
+            [PostLicenseAttachmentResultFields.COLUMN_METADATA]: this.metadata,
+        };
+    }
+}
+exports.PostLicenseAttachmentResult = PostLicenseAttachmentResult;
+_PostLicenseAttachmentResult_name = new WeakMap(), _PostLicenseAttachmentResult_lastModified = new WeakMap(), _PostLicenseAttachmentResult_url = new WeakMap(), _PostLicenseAttachmentResult_metadata = new WeakMap();
+//# sourceMappingURL=PostLicenseAttachmentResult.js.map

package/build/licenses/licensesClient.d.ts

@@ -28,6 +28,8 @@ import { ConsumptionDailyPrediction } from '../consumption';
 import { GetScheduledTasksResult } from './entities/schedule/getScheduledTasksResult';
 import { GetScheduleTaskResult } from './entities/schedule/getScheduleTaskResult';
 import { LicenceCouponCodeHistoryResult } from './entities/history/licenceCouponCodeHistoryResult';
+import { GetLicenseAttachmentsResult } from './entities/attachment/GetLicenseAttachmentsResult';
+import { PostLicenseAttachmentResult } from './entities/attachment/PostLicenseAttachmentResult';
 /**
  * Parameters passable to the request for refining search.
  */
@@ -138,6 +140,10 @@ export declare type BaseParameters<LicenseType, OfferType, endCustomerOrganizati
     offer?: OfferType;
     endCustomerOrganizationUnit?: endCustomerOrganizationUnitType;
 };
+export declare type AttachFileToLicenseParameters = {
+    name: string;
+    fileEncoded: string;
+};
 export declare type LicenseSortParameters = BaseParameters<LicenceFindDataSortParameters, OfferFindResultDataSortParameters, EndCustomerOrganizationUnitSortParameters>;
 export declare type LicenseCompareParameters = {
     [field: string]: unknown;
@@ -397,6 +403,10 @@ export declare class LicensesClient extends AbstractRestfulClient {
      *
      */
     find(postData?: LicenseFindPayload, perPage?: number, page?: number, parameters?: Parameters): Promise<FindResult>;
+    findAttachments(licenseReference: string, perPage?: number, page?: number, parameters?: Parameters): Promise<GetResult<GetLicenseAttachmentsResult>>;
+    attachFileToLicense(licenseReference: string, parameters: AttachFileToLicenseParameters): Promise<GetResult<PostLicenseAttachmentResult>>;
+    removeLicenseAttachment(licenseReference: string, documentName: string): Promise<void>;
+    getScheduledTasks(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetScheduledTasksResult>>;
     getConfigsRaw(reference: string): Promise<FindConfig>;
     getConfigs(reference: string): AsyncGenerator<ConfigFindResultData>;
     /**
@@ -424,7 +434,6 @@ export declare class LicensesClient extends AbstractRestfulClient {
     getCredentials(licenseReference: string, parameters?: Parameters): Promise<GetResult<CredentialsResult>>;
     setPricingRate(licenseReference: string, payload: LicensePricingRate, parameters?: Parameters): Promise<void>;
     scheduleTasks(licenseReference: string, payload: ScheduleTasks, parameters?: Parameters): Promise<GetResult<ScheduleTasksResult>>;
-    getScheduledTasks(licenseReference: string, parameters?: Parameters): Promise<GetResult<GetScheduledTasksResult>>;
     updateScheduledTask(licenseReference: string, scheduledTaskId: number, payload: UpdateScheduledTaskRequestType, parameters?: Parameters): Promise<void>;
     getScheduledTask(licenseReference: string, scheduledTaskId: number, parameters?: Parameters): Promise<GetResult<GetScheduleTaskResult>>;
     deleteScheduledTask(licenseReference: string, scheduledTaskId: number, parameters?: Parameters, payload?: DeleteScheduledTaskType): Promise<void>;

package/build/licenses/licensesClient.js

@@ -22,6 +22,8 @@ const consumption_1 = require("../consumption");
 const getScheduledTasksResult_1 = require("./entities/schedule/getScheduledTasksResult");
 const getScheduleTaskResult_1 = require("./entities/schedule/getScheduleTaskResult");
 const licenceCouponCodeHistoryResult_1 = require("./entities/history/licenceCouponCodeHistoryResult");
+const GetLicenseAttachmentsResult_1 = require("./entities/attachment/GetLicenseAttachmentsResult");
+const PostLicenseAttachmentResult_1 = require("./entities/attachment/PostLicenseAttachmentResult");
 /**
  * Parameters passable to the request for refining search.
  */
@@ -316,6 +318,25 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
         const response = await this.findRaw(rawLicensePayload, parameters);
         return new findResult_1.FindResult(response, this, rawLicensePayload, parameters);
     }
+    async findAttachments(licenseReference, perPage = 100, page = 1, parameters = {}) {
+        this.setPerPage(perPage);
+        this.setPage(page);
+        this.path = `/${licenseReference}/attachment`;
+        return new getResult_1.GetResult(GetLicenseAttachmentsResult_1.GetLicenseAttachmentsResult, await this.get(parameters));
+    }
+    async attachFileToLicense(licenseReference, parameters) {
+        this.path = `/${licenseReference}/attachment`;
+        return new getResult_1.GetResult(PostLicenseAttachmentResult_1.PostLicenseAttachmentResult, await this.post(parameters));
+    }
+    async removeLicenseAttachment(licenseReference, documentName) {
+        this.path = `/${licenseReference}/attachment/${documentName}`;
+        return await this.delete();
+    }
+    async getScheduledTasks(licenseReference, parameters = {}) {
+        this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
+        const response = await this.get(parameters);
+        return new getResult_1.GetResult(getScheduledTasksResult_1.GetScheduledTasksResult, response);
+    }
     getConfigsRaw(reference) {
         this.path = `/${reference}${this.CONFIGS_PATH}`;
         return this.get();
@@ -474,11 +495,6 @@ class LicensesClient extends abstractRestfulClient_1.AbstractRestfulClient {
         this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
         return new getResult_1.GetResult(scheduleTasksResult_1.ScheduleTasksResult, await this.post(payload, parameters));
     }
-    async getScheduledTasks(licenseReference, parameters = {}) {
-        this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}`;
-        const response = await this.get(parameters);
-        return new getResult_1.GetResult(getScheduledTasksResult_1.GetScheduledTasksResult, response);
-    }
     async updateScheduledTask(licenseReference, scheduledTaskId, payload, parameters = {}) {
         this.path = `/${licenseReference}${this.SCHEDULE_TASKS_PATH}/${scheduledTaskId}`;
         return await this.patch(payload, parameters);

package/package.json

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