oneentry 1.0.159 → 1.0.161

package/esm/integration-collections/integrationCollectionsApi.d.ts

@@ -0,0 +1,172 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionRow, ICollectionRowsResponce, ICollectionsApi } from './integrationCollectionsInterfaces.js';
+/**
+ * Controllers for working with attributes.
+ * @handle /api/content/integration-collections
+ * @class IntegrationCollectionsApi
+ * @augments AsyncModules
+ * @implements {ICollectionsApi}
+ * @description This class provides methods to interact with integration collections, including retrieving all collections, getting a single collection by ID, and managing collection rows.
+ */
+export default class IntegrationCollectionsApi extends AsyncModules implements ICollectionsApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     *
+     */
+    constructor(state: StateModule);
+    private _defaultQuery;
+    /**
+     * Get all collections.
+     * @handleName getICollections
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {object} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 0,
+          "offset": 30,
+          "entityType": "orders",
+          "entityId": 1
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollections getICollections} documentation.
+     */
+    getICollections(langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
+    /**
+     * Get a single collection object by id.
+     * @handleName getICollectionById
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionEntity | IError>} Returns an ICollection object or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionById getICollectionById} documentation.
+     */
+    getICollectionById(id: number, langCode?: string): Promise<ICollectionEntity | IError>;
+    /**
+     * Get all records belonging to the collection by collection id.
+     * @handleName getICollectionRowsById
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {any} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 0,
+          "offset": 30,
+          "entityType": "orders",
+          "entityId": 1
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get all records belonging to the collection by collection id.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsById getICollectionRowsById} documentation.
+     */
+    getICollectionRowsById(id: number, langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionRowsResponce | IError>;
+    /**
+     * Check for the existence of a text identifier (marker).
+     * @handleName validateICollectionMarker
+     * @param {string} marker - Collection marker. Example: "collection1".
+     * @returns {Promise<ICollectionIsValid | IError>} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @example
+        {
+          "valid": true
+        }
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Check for the existence of a text identifier (marker).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/validateICollectionMarker validateICollectionMarker} documentation.
+     */
+    validateICollectionMarker(marker: string): Promise<ICollectionIsValid | IError>;
+    /**
+     * Getting all records from the collection.
+     * @handleName getICollectionRowsByMarker
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsByMarker getICollectionRowsByMarker} documentation.
+     */
+    getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
+    /**
+     * Getting one record from the collection.
+     * @handleName getICollectionRowByMarkerAndId
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {number} id - Collection record identifier. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowByMarkerAndId getICollectionRowByMarkerAndId} documentation.
+     */
+    getICollectionRowByMarkerAndId(marker: string, id: number, langCode?: string): Promise<ICollectionRow | IError>;
+    /**
+     * Create a record in the collection.
+     * @handleName createICollectionRow
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {ICollectionFormObject} body - Object for creating a record.
+     * @example
+        {
+          "formIdentifier": "collection-form",
+          "formData": [
+            {
+            "marker": "collection_marker",
+            "type": "string",
+            "value": "Collection marker"
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Create a record in the collection.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/createICollectionRow createICollectionRow} documentation.
+     */
+    createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<ICollectionRow | IError>;
+    /**
+     * Edit a record in the collection.
+     * @handleName updateICollectionRow
+     * @param {string} marker - Text identifier of the collection. Example: "collection1".
+     * @param {number} id - Row identifier in the collection. Example: 12.
+     * @param {object} body - Object for updating a record in the collection.
+     * @example
+        {
+          "formIdentifier": "collection-form",
+          "formData": [
+            {
+              "marker": "collection_marker",
+              "type": "string",
+              "value": "Collection marker"
+            }
+          ]
+        }
+     * @param {string} body.formIdentifier - Textual identifier of the form. Example: "collection-form".
+     * @param {any} body.formData - Object with the form data.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Edit a record in the collection.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/updateICollectionRow updateICollectionRow} documentation.
+     */
+    updateICollectionRow(marker: string, id: number, body: {
+        formIdentifier: string;
+        formData: any;
+    }, langCode?: string): Promise<ICollectionRow | IError>;
+    /**
+     * Deletion of collection record object
+     * @handleName deleteICollectionRowByMarkerAndId
+     * @param {string} marker - text identifier of the collection Example: "collection1".
+     * @param {number} id - record identifier in the collection Example: 12.
+     * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Deletion of collection record object
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/deleteICollectionRowByMarkerAndId deleteICollectionRowByMarkerAndId} documentation.
+     */
+    deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
+}

package/esm/integration-collections/integrationCollectionsApi.js

@@ -0,0 +1,224 @@
+/* eslint-disable jsdoc/reject-any-type */
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./integrationCollectionsSchemas.js'));
+/**
+ * Controllers for working with attributes.
+ * @handle /api/content/integration-collections
+ * @class IntegrationCollectionsApi
+ * @augments AsyncModules
+ * @implements {ICollectionsApi}
+ * @description This class provides methods to interact with integration collections, including retrieving all collections, getting a single collection by ID, and managing collection rows.
+ */
+export default class IntegrationCollectionsApi extends AsyncModules {
+    /**
+     *
+     */
+    constructor(state) {
+        super(state);
+        this._defaultQuery = {
+            langCode: 'en_US',
+            offset: 0,
+            limit: 30,
+        };
+        this._url = state.url + '/api/content/integration-collections';
+    }
+    /**
+     * Get all collections.
+     * @handleName getICollections
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {object} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 0,
+          "offset": 30,
+          "entityType": "orders",
+          "entityId": 1
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollections getICollections} documentation.
+     */
+    async getICollections(langCode = this.state.lang, userQuery) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const query = { ...this._defaultQuery, ...userQuery, langCode };
+        const result = await this._fetchGet(`?` + this._queryParamsToString(query));
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('CollectionsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Get a single collection object by id.
+     * @handleName getICollectionById
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionEntity | IError>} Returns an ICollection object or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionById getICollectionById} documentation.
+     */
+    async getICollectionById(id, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/${id}?` + this._queryParamsToString({ langCode }));
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('CollectionEntitySchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Get all records belonging to the collection by collection id.
+     * @handleName getICollectionRowsById
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {any} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 0,
+          "offset": 30,
+          "entityType": "orders",
+          "entityId": 1
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get all records belonging to the collection by collection id.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsById getICollectionRowsById} documentation.
+     */
+    async getICollectionRowsById(id, langCode = this.state.lang, userQuery) {
+        const result = await this._fetchGet(`/${id}/rows?` +
+            this._queryParamsToString({
+                ...this._defaultQuery,
+                ...userQuery,
+                langCode,
+            }));
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('CollectionRowsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Check for the existence of a text identifier (marker).
+     * @handleName validateICollectionMarker
+     * @param {string} marker - Collection marker. Example: "collection1".
+     * @returns {Promise<ICollectionIsValid | IError>} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @example
+        {
+          "valid": true
+        }
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Check for the existence of a text identifier (marker).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/validateICollectionMarker validateICollectionMarker} documentation.
+     */
+    async validateICollectionMarker(marker) {
+        const result = await this._fetchGet(`/marker-validation/${marker}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('CollectionIsValidSchema'));
+        return this._normalizeData(validated);
+    }
+    /**
+     * Getting all records from the collection.
+     * @handleName getICollectionRowsByMarker
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsByMarker getICollectionRowsByMarker} documentation.
+     */
+    async getICollectionRowsByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}/rows?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('CollectionRowsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Getting one record from the collection.
+     * @handleName getICollectionRowByMarkerAndId
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {number} id - Collection record identifier. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowByMarkerAndId getICollectionRowByMarkerAndId} documentation.
+     */
+    async getICollectionRowByMarkerAndId(marker, id, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}/rows/${id}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('CollectionRowSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Create a record in the collection.
+     * @handleName createICollectionRow
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {ICollectionFormObject} body - Object for creating a record.
+     * @example
+        {
+          "formIdentifier": "collection-form",
+          "formData": [
+            {
+            "marker": "collection_marker",
+            "type": "string",
+            "value": "Collection marker"
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Create a record in the collection.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/createICollectionRow createICollectionRow} documentation.
+     */
+    async createICollectionRow(marker, body, langCode = this.state.lang) {
+        const response = await this._fetchPost(`/marker/${marker}/rows?langCode=${langCode}`, body);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(response, schema('CollectionRowSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Edit a record in the collection.
+     * @handleName updateICollectionRow
+     * @param {string} marker - Text identifier of the collection. Example: "collection1".
+     * @param {number} id - Row identifier in the collection. Example: 12.
+     * @param {object} body - Object for updating a record in the collection.
+     * @example
+        {
+          "formIdentifier": "collection-form",
+          "formData": [
+            {
+              "marker": "collection_marker",
+              "type": "string",
+              "value": "Collection marker"
+            }
+          ]
+        }
+     * @param {string} body.formIdentifier - Textual identifier of the form. Example: "collection-form".
+     * @param {any} body.formData - Object with the form data.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Edit a record in the collection.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/updateICollectionRow updateICollectionRow} documentation.
+     */
+    async updateICollectionRow(marker, id, body, langCode = this.state.lang) {
+        const response = await this._fetchPut(`/marker/${marker}/rows/${id}?` + `langCode=${langCode}`, body);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(response, schema('CollectionRowSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Deletion of collection record object
+     * @handleName deleteICollectionRowByMarkerAndId
+     * @param {string} marker - text identifier of the collection Example: "collection1".
+     * @param {number} id - record identifier in the collection Example: 12.
+     * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Deletion of collection record object
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/deleteICollectionRowByMarkerAndId deleteICollectionRowByMarkerAndId} documentation.
+     */
+    async deleteICollectionRowByMarkerAndId(marker, id) {
+        const result = await this._fetchDelete(`/marker/${marker}/rows/${id}`);
+        return result;
+    }
+}