zudello-integration-sdk 1.0.4 → 1.0.6

package/package.json

@@ -1,23 +1,23 @@
 {
-  "name": "zudello-integration-sdk",
-  "version": "1.0.4",
-  "description": "Zudello Integrations SDK",
-  "main": "./src/index.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/zudello/integration-sdk.git"
-  },
-  "files": [
-    "src"
-  ],
-  "dependencies": {
-    "@aws-sdk/client-s3": "^3.658.0",
-    "axios": "^1.6.7",
-    "dotenv": "^16.4.5",
-    "lodash": "^4.17.21",
-    "moment-timezone": "^0.5.45",
-    "perf_hooks": "^0.0.1",
-    "standard": "^17.1.0"
-  },
-  "license": "MIT"
+	"name": "zudello-integration-sdk",
+	"version": "1.0.6",
+	"description": "Zudello Integrations SDK",
+	"main": "./src/index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/zudello/integration-sdk.git"
+	},
+	"files": [
+		"src"
+	],
+	"dependencies": {
+		"@aws-sdk/client-s3": "^3.658.0",
+		"axios": "^1.6.7",
+		"dotenv": "^16.4.5",
+		"lodash": "^4.17.21",
+		"moment-timezone": "^0.5.45",
+		"perf_hooks": "^0.0.1",
+		"standard": "^17.1.0"
+	},
+	"license": "MIT"
 }

package/src/sdk/Zudello.js

@@ -1,206 +1,225 @@
-'use strict'
-
-const _ = require('lodash')
-
-const BaseSDK = require('./Base')
-const AccountModule = require('./submodules/zudello/Account')
-const AccountGroupModule = require('./submodules/zudello/AccountGroup')
-const AccountingPeriodModule = require('./submodules/zudello/AccountingPeriod')
-const CostCentreModule = require('./submodules/zudello/CostCentre')
-const CostTypeModule = require('./submodules/zudello/CostType')
-const CustomerModule = require('./submodules/zudello/Customer')
-const CustomerCategoryModule = require('./submodules/zudello/CustomerCategory')
-const CustomerGroupModule = require('./submodules/zudello/CustomerGroup')
-const CurrencyModule = require('./submodules/zudello/Currency')
-const DepartmentModule = require('./submodules/zudello/Department')
-const EmployeeModule = require('./submodules/zudello/Employee')
-const SubsidiaryModule = require('./submodules/zudello/Subsidiary')
-const LocationModule = require('./submodules/zudello/Location')
-const TaxRateModule = require('./submodules/zudello/tax/Rate')
-const TaxSolutionModule = require('./submodules/zudello/tax/Solution')
-const ItemModule = require('./submodules/zudello/Item')
-const ItemCategoryModule = require('./submodules/zudello/ItemCategory')
-const ItemGroupModule = require('./submodules/zudello/ItemGroup')
-const PurchaseOrderModule = require('./submodules/zudello/PurchaseOrder')
-const PaymentTermModule = require('./submodules/zudello/PaymentTerm')
-const PaymentMethodModule = require('./submodules/zudello/PaymentMethod')
-const ProjectModule = require('./submodules/zudello/Project')
-const ProjectGroupModule = require('./submodules/zudello/ProjectGroup')
-const ProjectTaskModule = require('./submodules/zudello/ProjectTask')
-const SupplierCategoryModule = require('./submodules/zudello/SupplierCategory')
-const SupplierGroupModule = require('./submodules/zudello/SupplierGroup')
-const UomModule = require('./submodules/zudello/Uom')
-const WarehouseModule = require('./submodules/zudello/Warehouse')
-const ZoneModule = require('./submodules/zudello/Zone')
-const SupplierModule = require('./submodules/zudello/Supplier')
-const FixedAssetModule = require('./submodules/zudello/FixedAsset')
-const UniversalModule = require('./submodules/zudello/Universal')
+"use strict";
+
+const _ = require("lodash");
+
+const BaseSDK = require("./Base");
+const AccountModule = require("./submodules/zudello/Account");
+const AccountGroupModule = require("./submodules/zudello/AccountGroup");
+const AccountingPeriodModule = require("./submodules/zudello/AccountingPeriod");
+const CostCentreModule = require("./submodules/zudello/CostCentre");
+const CostTypeModule = require("./submodules/zudello/CostType");
+const CustomerModule = require("./submodules/zudello/Customer");
+const CustomerCategoryModule = require("./submodules/zudello/CustomerCategory");
+const CustomerGroupModule = require("./submodules/zudello/CustomerGroup");
+const CurrencyModule = require("./submodules/zudello/Currency");
+const DepartmentModule = require("./submodules/zudello/Department");
+const EmployeeModule = require("./submodules/zudello/Employee");
+const SubsidiaryModule = require("./submodules/zudello/Subsidiary");
+const LocationModule = require("./submodules/zudello/Location");
+const TaxRateModule = require("./submodules/zudello/tax/Rate");
+const TaxSolutionModule = require("./submodules/zudello/tax/Solution");
+const ItemModule = require("./submodules/zudello/Item");
+const ItemCategoryModule = require("./submodules/zudello/ItemCategory");
+const ItemGroupModule = require("./submodules/zudello/ItemGroup");
+const PurchaseOrderModule = require("./submodules/zudello/PurchaseOrder");
+const PaymentTermModule = require("./submodules/zudello/PaymentTerm");
+const PaymentMethodModule = require("./submodules/zudello/PaymentMethod");
+const ProjectModule = require("./submodules/zudello/Project");
+const ProjectGroupModule = require("./submodules/zudello/ProjectGroup");
+const ProjectTaskModule = require("./submodules/zudello/ProjectTask");
+const SupplierCategoryModule = require("./submodules/zudello/SupplierCategory");
+const SupplierGroupModule = require("./submodules/zudello/SupplierGroup");
+const UomModule = require("./submodules/zudello/Uom");
+const WarehouseModule = require("./submodules/zudello/Warehouse");
+const ZoneModule = require("./submodules/zudello/Zone");
+const SupplierModule = require("./submodules/zudello/Supplier");
+const FixedAssetModule = require("./submodules/zudello/FixedAsset");
+const UniversalModule = require("./submodules/zudello/Universal");
 
 class ZudelloSDK extends BaseSDK {
-  /**
-   * Constructor.
-   * @param {class} auth Auth class object with authorized api instance.
-   * @param {string} connectionUUID The UUID of the Connection we're working on.
-   */
-  constructor (auth, organizationUUID, apiURL, apiVersion, loggerClass = null) {
-    super({
-      auth,
-      organizationUUID,
-      apiURL,
-      apiVersion,
-      isExternal: false,
-      integrationName: 'Zudello',
-      loggerClass
-    })
-
-    this.staticFieldsForUpdate = {
-      enrich: false,
-      extractedEvent: false,
-      update: true
-    }
-
-    /**
-     * Create submodule instances.
-     */
-    this.account = new AccountModule(this)
-    this.accountGroup = new AccountGroupModule(this)
-    this.accountingPeriod = new AccountingPeriodModule(this)
-    this.costCentre = new CostCentreModule(this)
-    this.costType = new CostTypeModule(this)
-    this.customer = new CustomerModule(this)
-    this.customerCategory = new CustomerCategoryModule(this)
-    this.customerGroup = new CustomerGroupModule(this)
-    this.currency = new CurrencyModule(this)
-    this.department = new DepartmentModule(this)
-    this.employee = new EmployeeModule(this)
-    this.subsidiary = new SubsidiaryModule(this)
-    this.location = new LocationModule(this)
-    this.item = new ItemModule(this)
-    this.itemCategory = new ItemCategoryModule(this)
-    this.itemGroup = new ItemGroupModule(this)
-    this.purchaseOrder = new PurchaseOrderModule(this)
-    this.paymentTerm = new PaymentTermModule(this)
-    this.paymentMethod = new PaymentMethodModule(this)
-    this.project = new ProjectModule(this)
-    this.projectGroup = new ProjectGroupModule(this)
-    this.projectTask = new ProjectTaskModule(this)
-    this.supplierCategory = new SupplierCategoryModule(this)
-    this.supplierGroup = new SupplierGroupModule(this)
-    this.warehouse = new WarehouseModule(this)
-    this.uom = new UomModule(this)
-    this.zone = new ZoneModule(this)
-    this.supplier = new SupplierModule(this)
-    this.fixedAsset = new FixedAssetModule(this)
-    this.universal = new UniversalModule(this)
-    this.tax = {
-      rate: new TaxRateModule(this),
-      solution: new TaxSolutionModule(this)
-    }
-  }
-
-  async search ({ model, select, filter, orderBy = ['-created_at'], offset = 0, limit = 100 }) {
-    const validateIsEmpty = this.validator.isEmpty({ model, select, filter })
-
-    if (!validateIsEmpty.valid) {
-      return this.responseHandler.error(validateIsEmpty.errors)
-    }
-
-    return await this.makeRequest('POST', `${this.apiURL}/team-data/${this.apiVersion}/resources/search`, {
-      model,
-      offset,
-      limit,
-      select,
-      order_by: orderBy,
-      filter,
-      exclude: {},
-      annotate: {}
-    })
-  }
-
-  async fetch ({ model, uuid, fetchDetails = true, simplified = true }) {
-    const validateIsEmpty = this.validator.isEmpty({ model, uuid })
-
-    if (!validateIsEmpty.valid) {
-      return this.responseHandler.error(validateIsEmpty.errors)
-    }
-
-    return await this.makeRequest('GET', `${this.apiURL}/team-data/${this.apiVersion}/resources`, {
-      model,
-      uuid,
-      fetch_details: fetchDetails,
-      simplified,
-    })
-  }
-
-  async getFileAttachment ({ uuid, type }) {
-    const validateIsEmpty = this.validator.isEmpty({ uuid, type })
-
-    if (!validateIsEmpty.valid) {
-      return this.responseHandler.error(validateIsEmpty.errors)
-    }
-
-    if (!['EXTRACTED', 'OCR'].includes(type)) {
-      return this.responseHandler.error('The attachment type can either be EXTRACTED or OCR')
-    }
-
-    return await this.makeRequest('GET', `${this.apiURL}/team-data/${this.apiVersion}/files/download/Transaction/${uuid}/${type}`, {}, {}, true)
-  }
-
-  async update ({ model, module = null, submodule = null, data, clearNulls = true, simplified = false, submit = false, updateStatus = false }) {
-    const validateIsEmpty = this.validator.isEmpty({ model, data })
-
-    if (!validateIsEmpty.valid) {
-      return this.responseHandler.error(validateIsEmpty.errors)
-    }
-
-    data = this.mapUpdateOrCreateData({
-      data: [data],
-      staticFields: {
-        ...this.staticFieldsForUpdate,
-        model,
-        module,
-        submodule
-      },
-      submit,
-      updateStatus
-    })
-
-    return await this.updateOrCreate({ data, clearNulls, simplified })
-  }
-
-  async updateOrCreate ({ data, clearNulls = true, simplified = false }) {
-    const validateIsEmpty = this.validator.isEmpty({ data })
-
-    if (!validateIsEmpty.valid) {
-      return this.responseHandler.error(validateIsEmpty.errors)
-    }
-
-    return await this.makeRequest('POST', `${this.apiURL}/team-data/${this.apiVersion}/resources/update_or_create`, {
-      simplified,
-      clear_nulls: clearNulls,
-      data
-    })
-  }
-
-  mapUpdateOrCreateData ({ data = [], staticFields = {}, submit = false, updateStatus = false }) {
-    return _.map(data, (item) => {
-      return {
-        data: {
-          module: staticFields.module,
-          submodule: staticFields.submodule,
-          document_type: staticFields.documentType,
-          ...item
-        },
-        model: staticFields.model,
-        submit: submit,
-        enrich: staticFields.enrich,
-        extracted_event: staticFields.extractedEvent,
-        update_status: updateStatus,
-        update: staticFields.update,
-        create: staticFields.create
-      }
-    })
-  }
+	/**
+	 * Constructor.
+	 * @param {class} auth Auth class object with authorized api instance.
+	 * @param {string} connectionUUID The UUID of the Connection we're working on.
+	 */
+	constructor(auth, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+		super({
+			auth,
+			organizationUUID,
+			apiURL,
+			apiVersion,
+			isExternal: false,
+			integrationName: "Zudello",
+			loggerClass,
+		});
+
+		this.staticFieldsForUpdate = {
+			enrich: false,
+			extractedEvent: false,
+			update: true,
+		};
+
+		/**
+		 * Create submodule instances.
+		 */
+		this.account = new AccountModule(this);
+		this.accountGroup = new AccountGroupModule(this);
+		this.accountingPeriod = new AccountingPeriodModule(this);
+		this.costCentre = new CostCentreModule(this);
+		this.costType = new CostTypeModule(this);
+		this.customer = new CustomerModule(this);
+		this.customerCategory = new CustomerCategoryModule(this);
+		this.customerGroup = new CustomerGroupModule(this);
+		this.currency = new CurrencyModule(this);
+		this.department = new DepartmentModule(this);
+		this.employee = new EmployeeModule(this);
+		this.subsidiary = new SubsidiaryModule(this);
+		this.location = new LocationModule(this);
+		this.item = new ItemModule(this);
+		this.itemCategory = new ItemCategoryModule(this);
+		this.itemGroup = new ItemGroupModule(this);
+		this.purchaseOrder = new PurchaseOrderModule(this);
+		this.paymentTerm = new PaymentTermModule(this);
+		this.paymentMethod = new PaymentMethodModule(this);
+		this.project = new ProjectModule(this);
+		this.projectGroup = new ProjectGroupModule(this);
+		this.projectTask = new ProjectTaskModule(this);
+		this.supplierCategory = new SupplierCategoryModule(this);
+		this.supplierGroup = new SupplierGroupModule(this);
+		this.warehouse = new WarehouseModule(this);
+		this.uom = new UomModule(this);
+		this.zone = new ZoneModule(this);
+		this.supplier = new SupplierModule(this);
+		this.fixedAsset = new FixedAssetModule(this);
+		this.universal = new UniversalModule(this);
+		this.tax = {
+			rate: new TaxRateModule(this),
+			solution: new TaxSolutionModule(this),
+		};
+	}
+
+	async search({ model, select, filter, orderBy = ["-created_at"], offset = 0, limit = 100 }) {
+		const validateIsEmpty = this.validator.isEmpty({ model, select, filter });
+
+		if (!validateIsEmpty.valid) {
+			return this.responseHandler.error(validateIsEmpty.errors);
+		}
+
+		return await this.makeRequest(
+			"POST",
+			`${this.apiURL}/team-data/${this.apiVersion}/resources/search`,
+			{
+				model,
+				offset,
+				limit,
+				select,
+				order_by: orderBy,
+				filter,
+				exclude: {},
+				annotate: {},
+			}
+		);
+	}
+
+	async fetch({ model, uuid, fetchDetails = true, simplified = true }) {
+		const validateIsEmpty = this.validator.isEmpty({ model, uuid });
+
+		if (!validateIsEmpty.valid) {
+			return this.responseHandler.error(validateIsEmpty.errors);
+		}
+
+		return await this.makeRequest("GET", `${this.apiURL}/team-data/${this.apiVersion}/resources`, {
+			model,
+			uuid,
+			fetch_details: fetchDetails,
+			simplified,
+		});
+	}
+
+	async getFileAttachment({ uuid, type }) {
+		const validateIsEmpty = this.validator.isEmpty({ uuid, type });
+
+		if (!validateIsEmpty.valid) {
+			return this.responseHandler.error(validateIsEmpty.errors);
+		}
+
+		return await this.makeRequest(
+			"GET",
+			`${this.apiURL}/team-data/${this.apiVersion}/files/download/Transaction/${uuid}/${type}`,
+			{},
+			{},
+			true
+		);
+	}
+
+	async update({
+		model,
+		module = null,
+		submodule = null,
+		data,
+		clearNulls = true,
+		simplified = false,
+		submit = false,
+		updateStatus = false,
+	}) {
+		const validateIsEmpty = this.validator.isEmpty({ model, data });
+
+		if (!validateIsEmpty.valid) {
+			return this.responseHandler.error(validateIsEmpty.errors);
+		}
+
+		data = this.mapUpdateOrCreateData({
+			data: [data],
+			staticFields: {
+				...this.staticFieldsForUpdate,
+				model,
+				module,
+				submodule,
+			},
+			submit,
+			updateStatus,
+		});
+
+		return await this.updateOrCreate({ data, clearNulls, simplified });
+	}
+
+	async updateOrCreate({ data, clearNulls = true, simplified = false }) {
+		const validateIsEmpty = this.validator.isEmpty({ data });
+
+		if (!validateIsEmpty.valid) {
+			return this.responseHandler.error(validateIsEmpty.errors);
+		}
+
+		return await this.makeRequest(
+			"POST",
+			`${this.apiURL}/team-data/${this.apiVersion}/resources/update_or_create`,
+			{
+				simplified,
+				clear_nulls: clearNulls,
+				data,
+			}
+		);
+	}
+
+	mapUpdateOrCreateData({ data = [], staticFields = {}, submit = false, updateStatus = false }) {
+		return _.map(data, (item) => {
+			return {
+				data: {
+					module: staticFields.module,
+					submodule: staticFields.submodule,
+					document_type: staticFields.documentType,
+					...item,
+				},
+				model: staticFields.model,
+				submit: submit,
+				enrich: staticFields.enrich,
+				extracted_event: staticFields.extractedEvent,
+				update_status: updateStatus,
+				update: staticFields.update,
+				create: staticFields.create,
+			};
+		});
+	}
 }
 
-module.exports = ZudelloSDK
+module.exports = ZudelloSDK;

package/src/sdk/submodules/myobAcumatica/Universal.js

@@ -1,109 +1,142 @@
-'use strict'
+"use strict";
 
 class UniversalModule {
-  /**
-   * Constructor.
-   * @param {class} parentModule Object of MYOBAccumatica class.
-   */
-  constructor (parentModule) {
-    this.module = parentModule
-  }
-
-  /**
-   * Universal Request By URL and Method.
-   * @param {string} url URL of request.
-   * @param {string} method Method of request.
-   * @param {object} qs Some available filters inside: offset, limit.
-   * @param {object} body Some available data inside.
-   * @returns {object} Universal Request Response.
-   */
-  async request ({ url, method, qs = {}, body = {} }) {
-    const validateIsEmpty = this.module.validator.isEmpty({ url, method })
-
-    if (!validateIsEmpty.valid) {
-      return this.module.responseHandler.error(validateIsEmpty.errors)
-    }
-
-    return await this.module.makeRequest('GET', `${this.module.apiURL}/zintegrations/action/5f752f97-03f9-4893-8245-7d03cf217e37`, {
-      mappable_parameters: {
-        url: {
-          value: url
-        },
-        method: {
-          value: method
-        },
-        qs: {
-          isMap: true,
-          value: JSON.stringify(qs)
-        },
-        body: {
-          isMap: true,
-          value: JSON.stringify(body)
-        }
-      }
-    })
-  }
-
-   /**
-   * Universal List By URL and Method.
-   * @param {string} url URL of listed data.
-   * @param {string} method Method of listed data.
-   * @param {object} qs Some available filters inside: $top, $skip, $filter, $extend.
-   * @returns {object} Universal List Response.
-   */
-   async list ({ url, method, qs = {} }) {
-    const validateIsEmpty = this.module.validator.isEmpty({ url, method })
-
-    if (!validateIsEmpty.valid) {
-      return this.module.responseHandler.error(validateIsEmpty.errors)
-    }
-
-    if (!qs.$skip) {
-      qs.$skip = 0
-    }
-
-    if (!qs.$top) {
-      qs.$top = 100
-    }
-
-    return await this.request({ url, method, qs })
-  }
-
-  /**
-   * Universal Auto Pagination Listing By URL and Method.
-   * @param {string} url URL of listed data.
-   * @param {string} method Method of listed data.
-   * @param {object} qs Some available filters inside: $top, $skip, $filter, $extend.
-   * @returns {object} Auto Pagination responses.
-   */
-  async * autoPaginationList ({ url, method, qs = {} }) {
-    if (!qs.$skip) {
-      qs.$skip = 0
-    }
-
-    if (!qs.$top) {
-      qs.$top = 100
-    }
-
-    let response = await this.list({ url, method, qs })
-    let currentPageCount = response?.data?.length
-    let currentOffset = qs.$skip
-
-    yield response
-
-    if (currentPageCount && currentPageCount === qs.$top) {
-      while (currentPageCount === qs.$top) {
-        currentOffset = currentOffset + qs.$top
-
-        qs.$skip = currentOffset
-
-        response = await this.list({ url, method, qs })
-        currentPageCount = response?.data?.length
-
-        yield response
-      }
-    }
-  }
+	/**
+	 * Constructor.
+	 * @param {class} parentModule Object of MYOBAccumatica class.
+	 */
+	constructor(parentModule) {
+		this.module = parentModule;
+	}
+
+	/**
+	 * Universal Request By URL and Method.
+	 * @param {string} url URL of request.
+	 * @param {string} method Method of request.
+	 * @param {object} qs Some available filters inside: offset, limit.
+	 * @param {object} body Some available data inside.
+	 * @returns {object} Universal Request Response.
+	 */
+	async request({ url, method, qs = {}, body = {} }) {
+		const validateIsEmpty = this.module.validator.isEmpty({ url, method });
+
+		if (!validateIsEmpty.valid) {
+			return this.module.responseHandler.error(validateIsEmpty.errors);
+		}
+
+		return await this.module.makeRequest(
+			"GET",
+			`${this.module.apiURL}/zintegrations/action/5f752f97-03f9-4893-8245-7d03cf217e37`,
+			{
+				mappable_parameters: {
+					url: {
+						value: url,
+					},
+					method: {
+						value: method,
+					},
+					qs: {
+						isMap: true,
+						value: JSON.stringify(qs),
+					},
+					body: {
+						isMap: true,
+						value: JSON.stringify(body),
+					},
+				},
+			}
+		);
+	}
+
+	/**
+	 * Universal List By URL and Method.
+	 * @param {string} url URL of listed data.
+	 * @param {string} method Method of listed data.
+	 * @param {object} qs Some available filters inside: $top, $skip, $filter, $extend.
+	 * @returns {object} Universal List Response.
+	 */
+	async list({ url, method, qs = {} }) {
+		const validateIsEmpty = this.module.validator.isEmpty({ url, method });
+
+		if (!validateIsEmpty.valid) {
+			return this.module.responseHandler.error(validateIsEmpty.errors);
+		}
+
+		if (!qs.$skip) {
+			qs.$skip = 0;
+		}
+
+		if (!qs.$top) {
+			qs.$top = 100;
+		}
+
+		return await this.request({ url, method, qs });
+	}
+
+	/**
+	 * Universal Auto Pagination Listing By URL and Method.
+	 * @param {string} url URL of listed data.
+	 * @param {string} method Method of listed data.
+	 * @param {object} qs Some available filters inside: $top, $skip, $filter, $extend.
+	 * @returns {object} Auto Pagination responses.
+	 */
+	async *autoPaginationList({ url, method, qs = {} }) {
+		if (!qs.$skip) {
+			qs.$skip = 0;
+		}
+
+		if (!qs.$top) {
+			qs.$top = 100;
+		}
+
+		let response = await this.list({ url, method, qs });
+		let currentPageCount = response?.data?.length;
+		let currentOffset = qs.$skip;
+
+		yield response;
+
+		if (currentPageCount && currentPageCount === qs.$top) {
+			while (currentPageCount === qs.$top) {
+				currentOffset = currentOffset + qs.$top;
+
+				qs.$skip = currentOffset;
+
+				response = await this.list({ url, method, qs });
+				currentPageCount = response?.data?.length;
+
+				yield response;
+			}
+		}
+	}
+
+	/**
+	 * Attachment Request By URL and Method.
+	 * @param {string} url URL of request.
+	 * @param {string} attachment URL of the attachment.
+	 * @returns {object} Universal Request Response.
+	 */
+	async attach({ url, method, qs = {}, body = {} }) {
+		const validateIsEmpty = this.module.validator.isEmpty({ url, attachment });
+
+		if (!validateIsEmpty.valid) {
+			return this.module.responseHandler.error(validateIsEmpty.errors);
+		}
+
+		return await this.module.makeRequest(
+			"GET",
+			`${this.module.apiURL}/zintegrations/action/086840ce-942c-44ee-b2dd-ca66e5dd7b02`,
+			{
+				mappable_parameters: {
+					url: {
+						value: url,
+					},
+					attachment: {
+						value: attachment,
+					},
+				},
+			}
+		);
+	}
 }
 
-module.exports = UniversalModule
+module.exports = UniversalModule;