@orchesty/connector-upgates 1.0.0

package/src/Batch/UpgatesGetProducts.ts

@@ -0,0 +1,216 @@
+import ABatchNode from '@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode';
+import { HttpMethods } from '@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods';
+import BatchProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/BatchProcessDto';
+import { DateTime } from 'luxon';
+import UpgatesApplication from '../UpgatesApplication';
+
+const LIST_PAGE_ENDPOINT = 'api/v2/products';
+
+export const NAME = 'upgates-get-products';
+
+export default class UpgatesGetProducts extends ABatchNode {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    public async processAction(dto: BatchProcessDto<IInput>): Promise<BatchProcessDto> {
+        const app = this.getApplication<UpgatesApplication>();
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+
+        const { from, productId, productIds } = dto.getJsonData();
+        const pageNumber = dto.getBatchCursor('1');
+
+        let url = LIST_PAGE_ENDPOINT;
+
+        if (productIds) {
+            url = `${url}?product_ids=${productIds}`;
+        } else if (productId) {
+            url = `${url}?product_id=${productId}`;
+        } else {
+            url = `${url}?page=${pageNumber}`;
+
+            const lastRun = from ?? app.getIsoDateFromDate(appInstall.getNonEncryptedSettings().productLastRun);
+            if (lastRun) {
+                url = `${url}&last_update_time_from=${lastRun}`;
+            }
+        }
+        const requestDto = app.getRequestDto(dto, appInstall, HttpMethods.GET, url);
+
+        const res = await this.getSender().send<IResponseJson>(requestDto);
+        const { number_of_pages, products } = res.getJsonBody();
+
+        if (Number(pageNumber) < number_of_pages) {
+            dto.setBatchCursor((Number(pageNumber) + 1).toString());
+        } else if (!productId) {
+            appInstall.setNonEncryptedSettings({ productLastRun: DateTime.now() });
+            const repo = this.getDbClient().getApplicationRepository();
+            await repo.update(appInstall);
+        }
+
+        dto.setItemList(products);
+
+        return dto;
+    }
+
+}
+
+/* eslint-disable @typescript-eslint/naming-convention */
+interface IResponseJson extends IProductJson {
+    number_of_pages: number;
+    number_of_items: number;
+}
+
+export interface IProductJson {
+    products: IProduct[];
+}
+
+export interface IProduct {
+    code: string;
+    code_supplier: string;
+    ean: string;
+    product_id: number;
+    active_yn: boolean;
+    archived_yn: boolean;
+    replacement_product_code: string;
+    can_add_to_basket_yn: boolean;
+    adult_yn: boolean;
+    descriptions: IProductDescription[];
+    manufacturer: string;
+    stock: number;
+    stock_position: number;
+    availability: string;
+    availability_type: AvailabilityTypeEnum;
+    weight: number;
+    shipment_group: string;
+    images: IProductImage[];
+    categories: IProductCategories;
+    groups: number[];
+    prices: IProductPrice[];
+    vats: Record<string, number>;
+    parameters: IProductParameters[];
+    labels: IProductLabel[];
+    variants: IProductVariant[];
+    related: string[];
+    accessories: string[];
+    alternative: string[];
+    gifts: string[];
+    sets: string[];
+    metas: IProductVariantMeta[];
+    admin_url: string;
+}
+
+export interface IProductDescription {
+    language: string;
+    title: string;
+    short_description: string;
+    long_description: string;
+    url: string;
+    unit: string;
+}
+
+interface IProductImage {
+    url: string;
+    main_yn: boolean;
+    list_yn: boolean;
+    position: number;
+    titles: IProductImageTitle[];
+}
+
+interface IProductImageTitle {
+    language: string;
+    title: string;
+}
+
+interface IProductCategories {
+    category_id: number;
+    code: string;
+    main_yn: boolean;
+    position: number;
+    name: string;
+}
+
+interface IProductPrice {
+    language: string;
+    currency: string;
+    pricelists: IProductPricePriceList[];
+}
+
+interface IProductPricePriceList {
+    name: string;
+    price_original: number;
+    product_discount: number;
+    product_discount_real: number;
+    price_sale: number;
+    price_with_vat: number;
+    price_without_vat: number;
+}
+
+interface IProductParameters {
+    name: Record<string, string>;
+    values: Record<string, string>;
+}
+
+interface IProductLabel {
+    name: Record<string, string>;
+    active_yn: boolean;
+    active_from: Date;
+    active_to: Date;
+}
+
+interface IProductVariant {
+    code: string;
+    code_supplier: string;
+    ean: string;
+    variant_id: number;
+    active_yn: boolean;
+    can_add_to_basket_yn: boolean;
+    stock: number;
+    stock_position: string;
+    availability: string;
+    availability_type: AvailabilityTypeEnum;
+    weight: number;
+    image: string;
+    prices: IProductPrice[];
+    parameters: IProductParameters[];
+    labels: IProductLabel[];
+    metas: IProductVariantMeta[];
+}
+
+interface IProductVariantMeta {
+    key: string;
+    type: MetaTypeEnum;
+    value: string|boolean;
+    values: IProductVariantMetaValues[];
+}
+
+interface IProductVariantMetaValues {
+    language: string;
+    value: string;
+}
+
+export interface IInput {
+    from?: string;
+    productId?: string;
+    productIds?: string;
+}
+
+enum AvailabilityTypeEnum {
+    ON_REQUEST = 'OnRequest',
+    NOT_AVAILABLE = 'NotAvailable',
+    IN_STOCK = 'InStock',
+    CUSTOM = 'Custom',
+}
+
+enum MetaTypeEnum {
+    RADIO = 'radio',
+    CHECKBOX = 'checkbox',
+    INPUT = 'input',
+    DATE = 'date',
+    EMAIL = 'email',
+    NUMBER = 'number',
+    SELECT = 'select',
+    MULTISELECT = 'multiselect',
+    TEXTAREA = 'textarea',
+    FORMATTED = 'formatted',
+}

package/src/Batch/__tests__/Data/UpgatesCreateWebhooks/input.json

@@ -0,0 +1,6 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {}
+}

package/src/Batch/__tests__/Data/UpgatesCreateWebhooks/mock.json

@@ -0,0 +1,14 @@
+{
+  "http": "POST https://private-anon-903e641b16-upgatesapiv2.apiary-mock.com/api/v2/webhooks",
+  "code": 200,
+  "body": {
+    "webhook": {
+      "id": 0,
+      "active_yn": false,
+      "name": "",
+      "url": "",
+      "event": ""
+    }
+  }
+}
+

package/src/Batch/__tests__/Data/UpgatesCreateWebhooks/output.json

@@ -0,0 +1,6 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": []
+}

package/src/Batch/__tests__/Data/UpgatesGetOrders/input.json

@@ -0,0 +1,6 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {}
+}

package/src/Batch/__tests__/Data/UpgatesGetOrders/lastRun-input.json

@@ -0,0 +1,6 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {}
+}

package/src/Batch/__tests__/Data/UpgatesGetOrders/lastRun-mock.json

@@ -0,0 +1,191 @@
+{
+    "http": "GET https://private-anon-903e641b16-upgatesapiv2.apiary-mock.com/api/v2/orders?page=1&creation_time_from=2022-09-22T08:21:27",
+    "code": 200,
+    "body": {
+        "current_page": 0,
+        "current_page_items": 0,
+        "number_of_pages": 0,
+        "number_of_items": 0,
+        "orders": [
+            {
+                "order_number": "",
+                "case_number": "",
+                "external_order_number": "",
+                "language_id": "",
+                "currency_id": "",
+                "default_currency_rate": "",
+                "prices_with_vat_yn": false,
+                "status_id": 0,
+                "status": "",
+                "paid_date": "",
+                "tracking_code": "",
+                "tracking_url": "",
+                "resolved_yn": false,
+                "oss_yn": false,
+                "internal_note": "",
+                "last_update_time": "",
+                "creation_time": "",
+                "variable_symbol": "",
+                "total_weight": 0,
+                "order_total": 0,
+                "order_total_before_round": 0,
+                "order_total_rest": 0,
+                "invoice_number": "",
+                "origin": "admin",
+                "admin_url": "",
+                "customer": {
+                    "email": "",
+                    "phone": "",
+                    "code": "",
+                    "customer_id": 0,
+                    "customer_pricelist_id": "",
+                    "pricelist_name": "",
+                    "pricelist_percent": "",
+                    "firstname_invoice": "",
+                    "surname_invoice": "",
+                    "street_invoice": "",
+                    "city_invoice": "",
+                    "state_invoice": "",
+                    "zip_invoice": "",
+                    "country_id_invoice": "",
+                    "postal_yn": false,
+                    "firstname_postal": "",
+                    "surname_postal": "",
+                    "street_postal": "",
+                    "city_postal": "",
+                    "state_postal": "",
+                    "zip_postal": "",
+                    "country_id_postal": "",
+                    "company_postal": "",
+                    "company_yn": false,
+                    "company": "",
+                    "ico": "",
+                    "dic": "",
+                    "vat_payer_yn": false,
+                    "customer_note": "",
+                    "agreements": [
+                        {
+                            "name": "",
+                            "valid_to": "",
+                            "status": false
+                        }
+                    ]
+                },
+                "products": [
+                    {
+                        "product_id": 0,
+                        "option_set_id": 0,
+                        "code": "",
+                        "code_supplier": "",
+                        "supplier": "",
+                        "ean": "",
+                        "title": "",
+                        "adult_yn": false,
+                        "quantity": 0,
+                        "unit": "",
+                        "length": "",
+                        "length_unit": "",
+                        "price_per_unit": 0,
+                        "price": 0,
+                        "price_with_vat": 0,
+                        "price_without_vat": 0,
+                        "vat": 0,
+                        "buy_price": 0,
+                        "recycling_fee": 0,
+                        "weight": 0,
+                        "availability": "",
+                        "invoice_info": "",
+                        "parameters": [
+                            {
+                                "name": "",
+                                "value": ""
+                            }
+                        ],
+                        "configurations": [
+                            {
+                                "name": "",
+                                "values": [
+                                    {
+                                        "value": "",
+                                        "operation": "",
+                                        "cena": 0
+                                    }
+                                ]
+                            }
+                        ],
+                        "categories": [
+                            {
+                                "category_id": 0,
+                                "code": ""
+                            }
+                        ],
+                        "image_url": ""
+                    }
+                ],
+                "discount_voucher": {
+                    "code": "",
+                    "type": "percent",
+                    "amount": 0,
+                    "discounts": [
+                        {
+                            "price": 0,
+                            "vat": 0
+                        }
+                    ]
+                },
+                "quantity_discount": {
+                    "type": "percent",
+                    "amount": 0,
+                    "discounts": [
+                        {
+                            "price": 0,
+                            "vat": 0
+                        }
+                    ]
+                },
+                "loyalty_points": {
+                    "one_point_for": 0,
+                    "amount": 0,
+                    "discounts": [
+                        {
+                            "price": 0,
+                            "vat": 0
+                        }
+                    ]
+                },
+                "shipment": {
+                    "id": 0,
+                    "code": "",
+                    "name": "",
+                    "price": 0,
+                    "vat": 0,
+                    "affiliate_id": "",
+                    "type": "",
+                    "packeta_carrier_id": 0
+                },
+                "payment": {
+                    "id": 0,
+                    "code": "",
+                    "name": "",
+                    "price": 0,
+                    "vat": 0,
+                    "eet_yn": false,
+                    "type": ""
+                },
+                "metas": [
+                    {
+                        "key": "",
+                        "type": "",
+                        "value": "",
+                        "values": [
+                            {
+                                "language": "",
+                                "value": ""
+                            }
+                        ]
+                    }
+                ]
+            }
+        ]
+    }
+}

package/src/Batch/__tests__/Data/UpgatesGetOrders/lastRun-output.json

@@ -0,0 +1,11 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": [
+        {
+            "body": "{\"order_number\":\"\",\"case_number\":\"\",\"external_order_number\":\"\",\"language_id\":\"\",\"currency_id\":\"\",\"default_currency_rate\":\"\",\"prices_with_vat_yn\":false,\"status_id\":0,\"status\":\"\",\"paid_date\":\"\",\"tracking_code\":\"\",\"tracking_url\":\"\",\"resolved_yn\":false,\"oss_yn\":false,\"internal_note\":\"\",\"last_update_time\":\"\",\"creation_time\":\"\",\"variable_symbol\":\"\",\"total_weight\":0,\"order_total\":0,\"order_total_before_round\":0,\"order_total_rest\":0,\"invoice_number\":\"\",\"origin\":\"admin\",\"admin_url\":\"\",\"customer\":{\"email\":\"\",\"phone\":\"\",\"code\":\"\",\"customer_id\":0,\"customer_pricelist_id\":\"\",\"pricelist_name\":\"\",\"pricelist_percent\":\"\",\"firstname_invoice\":\"\",\"surname_invoice\":\"\",\"street_invoice\":\"\",\"city_invoice\":\"\",\"state_invoice\":\"\",\"zip_invoice\":\"\",\"country_id_invoice\":\"\",\"postal_yn\":false,\"firstname_postal\":\"\",\"surname_postal\":\"\",\"street_postal\":\"\",\"city_postal\":\"\",\"state_postal\":\"\",\"zip_postal\":\"\",\"country_id_postal\":\"\",\"company_postal\":\"\",\"company_yn\":false,\"company\":\"\",\"ico\":\"\",\"dic\":\"\",\"vat_payer_yn\":false,\"customer_note\":\"\",\"agreements\":[{\"name\":\"\",\"valid_to\":\"\",\"status\":false}]},\"products\":[{\"product_id\":0,\"option_set_id\":0,\"code\":\"\",\"code_supplier\":\"\",\"supplier\":\"\",\"ean\":\"\",\"title\":\"\",\"adult_yn\":false,\"quantity\":0,\"unit\":\"\",\"length\":\"\",\"length_unit\":\"\",\"price_per_unit\":0,\"price\":0,\"price_with_vat\":0,\"price_without_vat\":0,\"vat\":0,\"buy_price\":0,\"recycling_fee\":0,\"weight\":0,\"availability\":\"\",\"invoice_info\":\"\",\"parameters\":[{\"name\":\"\",\"value\":\"\"}],\"configurations\":[{\"name\":\"\",\"values\":[{\"value\":\"\",\"operation\":\"\",\"cena\":0}]}],\"categories\":[{\"category_id\":0,\"code\":\"\"}],\"image_url\":\"\"}],\"discount_voucher\":{\"code\":\"\",\"type\":\"percent\",\"amount\":0,\"discounts\":[{\"price\":0,\"vat\":0}]},\"quantity_discount\":{\"type\":\"percent\",\"amount\":0,\"discounts\":[{\"price\":0,\"vat\":0}]},\"loyalty_points\":{\"one_point_for\":0,\"amount\":0,\"discounts\":[{\"price\":0,\"vat\":0}]},\"shipment\":{\"id\":0,\"code\":\"\",\"name\":\"\",\"price\":0,\"vat\":0,\"affiliate_id\":\"\",\"type\":\"\",\"packeta_carrier_id\":0},\"payment\":{\"id\":0,\"code\":\"\",\"name\":\"\",\"price\":0,\"vat\":0,\"eet_yn\":false,\"type\":\"\"},\"metas\":[{\"key\":\"\",\"type\":\"\",\"value\":\"\",\"values\":[{\"language\":\"\",\"value\":\"\"}]}]}",
+            "headers": {}
+        }
+    ]
+}

package/src/Batch/__tests__/Data/UpgatesGetOrders/mock.json

@@ -0,0 +1,191 @@
+{
+    "http": "GET https://private-anon-903e641b16-upgatesapiv2.apiary-mock.com/api/v2/orders?page=1",
+    "code": 200,
+    "body": {
+        "current_page": 0,
+        "current_page_items": 0,
+        "number_of_pages": 0,
+        "number_of_items": 0,
+        "orders": [
+            {
+                "order_number": "",
+                "case_number": "",
+                "external_order_number": "",
+                "language_id": "",
+                "currency_id": "",
+                "default_currency_rate": "",
+                "prices_with_vat_yn": false,
+                "status_id": 0,
+                "status": "",
+                "paid_date": "",
+                "tracking_code": "",
+                "tracking_url": "",
+                "resolved_yn": false,
+                "oss_yn": false,
+                "internal_note": "",
+                "last_update_time": "",
+                "creation_time": "",
+                "variable_symbol": "",
+                "total_weight": 0,
+                "order_total": 0,
+                "order_total_before_round": 0,
+                "order_total_rest": 0,
+                "invoice_number": "",
+                "origin": "admin",
+                "admin_url": "",
+                "customer": {
+                    "email": "",
+                    "phone": "",
+                    "code": "",
+                    "customer_id": 0,
+                    "customer_pricelist_id": "",
+                    "pricelist_name": "",
+                    "pricelist_percent": "",
+                    "firstname_invoice": "",
+                    "surname_invoice": "",
+                    "street_invoice": "",
+                    "city_invoice": "",
+                    "state_invoice": "",
+                    "zip_invoice": "",
+                    "country_id_invoice": "",
+                    "postal_yn": false,
+                    "firstname_postal": "",
+                    "surname_postal": "",
+                    "street_postal": "",
+                    "city_postal": "",
+                    "state_postal": "",
+                    "zip_postal": "",
+                    "country_id_postal": "",
+                    "company_postal": "",
+                    "company_yn": false,
+                    "company": "",
+                    "ico": "",
+                    "dic": "",
+                    "vat_payer_yn": false,
+                    "customer_note": "",
+                    "agreements": [
+                        {
+                            "name": "",
+                            "valid_to": "",
+                            "status": false
+                        }
+                    ]
+                },
+                "products": [
+                    {
+                        "product_id": 0,
+                        "option_set_id": 0,
+                        "code": "",
+                        "code_supplier": "",
+                        "supplier": "",
+                        "ean": "",
+                        "title": "",
+                        "adult_yn": false,
+                        "quantity": 0,
+                        "unit": "",
+                        "length": "",
+                        "length_unit": "",
+                        "price_per_unit": 0,
+                        "price": 0,
+                        "price_with_vat": 0,
+                        "price_without_vat": 0,
+                        "vat": 0,
+                        "buy_price": 0,
+                        "recycling_fee": 0,
+                        "weight": 0,
+                        "availability": "",
+                        "invoice_info": "",
+                        "parameters": [
+                            {
+                                "name": "",
+                                "value": ""
+                            }
+                        ],
+                        "configurations": [
+                            {
+                                "name": "",
+                                "values": [
+                                    {
+                                        "value": "",
+                                        "operation": "",
+                                        "cena": 0
+                                    }
+                                ]
+                            }
+                        ],
+                        "categories": [
+                            {
+                                "category_id": 0,
+                                "code": ""
+                            }
+                        ],
+                        "image_url": ""
+                    }
+                ],
+                "discount_voucher": {
+                    "code": "",
+                    "type": "percent",
+                    "amount": 0,
+                    "discounts": [
+                        {
+                            "price": 0,
+                            "vat": 0
+                        }
+                    ]
+                },
+                "quantity_discount": {
+                    "type": "percent",
+                    "amount": 0,
+                    "discounts": [
+                        {
+                            "price": 0,
+                            "vat": 0
+                        }
+                    ]
+                },
+                "loyalty_points": {
+                    "one_point_for": 0,
+                    "amount": 0,
+                    "discounts": [
+                        {
+                            "price": 0,
+                            "vat": 0
+                        }
+                    ]
+                },
+                "shipment": {
+                    "id": 0,
+                    "code": "",
+                    "name": "",
+                    "price": 0,
+                    "vat": 0,
+                    "affiliate_id": "",
+                    "type": "",
+                    "packeta_carrier_id": 0
+                },
+                "payment": {
+                    "id": 0,
+                    "code": "",
+                    "name": "",
+                    "price": 0,
+                    "vat": 0,
+                    "eet_yn": false,
+                    "type": ""
+                },
+                "metas": [
+                    {
+                        "key": "",
+                        "type": "",
+                        "value": "",
+                        "values": [
+                            {
+                                "language": "",
+                                "value": ""
+                            }
+                        ]
+                    }
+                ]
+            }
+        ]
+    }
+}

package/src/Batch/__tests__/Data/UpgatesGetOrders/orderNumber-input.json

@@ -0,0 +1,8 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "orderNumber": "20200101"
+    }
+}