oneentry 1.0.59 → 1.0.60

package/README.md

@@ -84,7 +84,9 @@ Now you can use the following links to jump to specific entries:
 - [Locales](#locales)
 - [Markers](#markers)
 - [Menus](#menus)
+- [Orders](#orders)
 - [Pages](#pages)
+- [Payments](#payments)
 - [Products](#products)
 - [ProductStatuses](#productstatuses)
 - [System](#system)
@@ -1401,6 +1403,201 @@ example: List [ OrderedMap { "id": 11, "pageUrl": "122", "localizeInfos": Ordere
 
 ---
 
+
+
+## <h2 id="orders"> Orders </h2>
+
+```js
+const { Orders } = defineOneEntry('your-url')
+```
+
+### Orders.getOrderByMarker(marker, langCode)
+
+```js
+const value = await Pages.getOrderByMarker('my-order', 'en_US')
+```
+
+> This method retrieves one order storage object by marker.
+
+Example return:
+```json
+{
+  "id": 1764,
+  "localizeInfos": {
+    "title": "Order 1"
+  },
+  "identifier": "catalog",
+  "generalTypeId": 4,
+  "formIdentifier": "catalog-form",
+  "paymentAccountIdentifiers": [
+    {
+      "identifier": "p1"
+    }
+  ]
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**localizeInfos:**	Record<string, any> <br>
+*json description of the main page data object taking into account the language "en_US" (for example)* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
+
+**identifier** string <br>
+*textual identifier for the record field* <br>
+example: catalog <br>
+
+**generalTypeId** number <br>
+*type identifier* <br>
+example: 4 <br>
+
+**formIdentifier**	string <br>
+*textual identifier for the form used by the order storage* <br>
+example: catalog-form <br>
+
+**paymentAccountIdentifiers** Array<{identifier:string} <br>
+*array of textual identifiers of payment accounts used by the order storage* <br>
+example:  [{ "identifier": "p1" }] <br>
+
+</details>
+
+
+### Orders.createOrder(marker, data)
+
+```js
+ const body = {
+    "formIdentifier": "order_form",
+    "paymentAccountIdentifier": "stripe",
+    "currency": "USD",
+    "formData": {
+        "en_US": [
+            {
+                "marker": "name_order",
+                "value": "Alex"
+            },
+            {
+                "marker": "phone_order",
+                "value": "+19999999999"
+            },
+            {
+                "marker": "email_order",
+                "value": "example@oneentry.cloud"
+            }
+        ]
+    },
+    "products": [
+        {
+            "productId": 444,
+            "quantity": 1,
+            "price": "0.1"
+        },
+        {
+            "productId": 446,
+            "quantity": 3,
+            "price": "123"
+        }
+    ]
+}
+
+const value = await Pages.createOrder('my-order', body)
+```
+
+> This method retrieves one order storage object by marker.
+
+Example return:
+```json
+{
+  "statusIdentifier": "inprogress",
+  "formIdentifier": "order-form",
+  "paymentIdentifier": "payment-1",
+  "formData": [
+    {
+      "marker": "name_1",
+      "value": "Name"
+    }
+  ],
+  "products": [
+    {
+      "id": 1,
+      "title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
+      "sku": null,
+      "price": "1.00",
+      "quantity": 10,
+      "previewImage": [
+        {
+          "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
+          "downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
+          "size": 296391,
+          "previewLink": ""
+        }
+      ]
+    }
+  ],
+  "totalSum": "12.00",
+  "currency": "USD",
+  "createdDate": "2023-01-01 12:12",
+  "price": 20,
+  "paymentAccountIdentifier": "payment-1",
+  "paymentAccountLocalizeInfos": {
+    "title": "Account 1"
+  }
+}
+```
+<details>
+<summary>Schema</summary>
+
+**statusIdentifier:**	string <br>
+*text identifier of the order status* <br>
+example: inprogress <br>
+
+**formIdentifier:**	string <br>
+*text identifier of the form status* <br>
+example: order-form <br>
+
+**paymentIdentifier** string <br>
+*text identifier of the order payment* <br>
+example: payment-1 <br>
+
+**formData** FormDataType <br>
+*data submitted by the form linked to the order store* <br>
+example: [{ "marker": "name_1", "value": "Name" } ] <br>
+
+**products**	Record<string, string | any>[] <br>
+*array of products added to order* <br>
+
+**totalSum** string <br>
+*total order amount* <br>
+example:  12.00 <br>
+
+**currency** string <br>
+*currency used to pay for the order* <br>
+example: USD <br>
+
+**createdDate** string <br>
+*date when the order was created* <br>
+example: 2023-01-01 12:12 <br>
+
+**price** number <br>
+*price of the product per unit (at the time of ordering)* <br>
+example: 20.00 <br>
+
+**paymentAccountIdentifier** string <br>
+*textual identifier for the order payment* <br>
+example: payment-1 <br>
+
+**paymentAccountLocalizeInfos** CommonLocalizeInfos <br>
+*payment account name considering localization* <br>
+example: { "title": "Account 1" } <br>
+</details>
+
+---
+
+
+
 ## <h2 id="pages"> Pages </h2>
 
 
@@ -2364,6 +2561,523 @@ Example return:
 ---
 
 
+## <h2 id="payments"> Payments </h2>
+
+```js
+const { Payments } = defineOneEntry('your-url')
+```
+
+### Payments.getSessions(limit, offset)
+
+```js
+const value = await Payments.getSessions(30, 0)
+```
+
+> This method get list of a payment session. It returns a Promise that resolves to a payment session object.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "updatedDate": "2024-04-10T16:39:04.297Z",
+    "version": 10,
+    "identifier": "catalog",
+    "type": "session",
+    "lineItems": [
+      {
+        "quantity": 1,
+        "amount": 5,
+        "currency": "USD",
+        "name": "T-shirt",
+        "description": "White T-shirt"
+      }
+    ],
+    "orderId": 1,
+    "paymentAccountId": 1,
+    "status": "completed",
+    "sessionId": "9BE88048TU058770M",
+    "paymentUrl": "https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M",
+    "successUrl": "https://example.com/success",
+    "cancelUrl": "https://example.com/cancel",
+    "intent": {
+      "amount": 1,
+      "currency": "usd"
+    },
+    "intentId": 1,
+    "clientSecret": "pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2"
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**updatedDate:** string <br>
+*object modification date* <br>
+
+**version:**	number <br>
+*object modification version number* <br>
+example: 10 <br>
+
+**identifier:**	string <br>
+*text identifier for the record field* <br>
+example: catalog <br>
+
+**type:**	string <br>
+*type may be 'session' or 'intent'* <br>
+example: session <br>
+
+**lineItems:**	array <br>
+*list of items* <br>
+
+**orderId:**	number <br>
+*order identifier* <br>
+example: 1 <br>
+
+**paymentAccountId:**	number <br>
+*payment account object identifier* <br>
+example: 1 <br>
+
+**status:** string <br>
+*payment status* <br>
+example: completed <br>
+
+**sessionId:** string <br>
+*Payment ID from an external provider* <br>
+example: 9BE88048TU058770M <br>
+
+**paymentUrl:** string <br>
+*payment link* <br>
+example: https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M <br>
+
+**successUrl:**	string <br>
+*redirect link after successful payment* <br>
+example: https://example.com/success <br>
+
+**cancelUrl**	string <br>
+*redirect link after payment cancellation* <br>
+example:  https://example.com/cancel <br>
+
+**intent**	string <br>
+example:  { "amount": 1, "currency": "usd" } <br>
+
+**intentId**	number <br>
+*intent object identifier* <br>
+example:  1 <br>
+
+**clientSecret**	string <br>
+*client secret key* <br>
+example:  pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2 <br>
+
+</details>
+
+
+### Payments.getSessionById(id)
+
+```js
+const value = await Payments.getSessionById(1764)
+```
+
+> This method get a single payment session object by its identifier. It returns a Promise that resolves to a payment session object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "updatedDate": "2024-04-10T16:39:04.297Z",
+  "version": 10,
+  "identifier": "catalog",
+  "type": "session",
+  "lineItems": [
+    {
+      "quantity": 1,
+      "amount": 5,
+      "currency": "USD",
+      "name": "T-shirt",
+      "description": "White T-shirt"
+    }
+  ],
+  "orderId": 1,
+  "paymentAccountId": 1,
+  "status": "completed",
+  "sessionId": "9BE88048TU058770M",
+  "paymentUrl": "https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M",
+  "successUrl": "https://example.com/success",
+  "cancelUrl": "https://example.com/cancel",
+  "intent": {
+    "amount": 1,
+    "currency": "usd"
+  },
+  "intentId": 1,
+  "clientSecret": "pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2"
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**updatedDate:** string <br>
+*object modification date* <br>
+
+**version:**	number <br>
+*object modification version number* <br>
+example: 10 <br>
+
+**identifier:**	string <br>
+*text identifier for the record field* <br>
+example: catalog <br>
+
+**type:**	string <br>
+*type may be 'session' or 'intent'* <br>
+example: session <br>
+
+**lineItems:**	array <br>
+*list of items* <br>
+
+**orderId:**	number <br>
+*order identifier* <br>
+example: 1 <br>
+
+**paymentAccountId:**	number <br>
+*payment account object identifier* <br>
+example: 1 <br>
+
+**status:** string <br>
+*payment status* <br>
+example: completed <br>
+
+**sessionId:** string <br>
+*Payment ID from an external provider* <br>
+example: 9BE88048TU058770M <br>
+
+**paymentUrl:** string <br>
+*payment link* <br>
+example: https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M <br>
+
+**successUrl:**	string <br>
+*redirect link after successful payment* <br>
+example: https://example.com/success <br>
+
+**cancelUrl**	string <br>
+*redirect link after payment cancellation* <br>
+example:  https://example.com/cancel <br>
+
+**intent**	string <br>
+example:  { "amount": 1, "currency": "usd" } <br>
+
+**intentId**	number <br>
+*intent object identifier* <br>
+example:  1 <br>
+
+**clientSecret**	string <br>
+*client secret key* <br>
+example:  pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2 <br>
+
+</details>
+
+
+### Payments.createSession(body)
+
+```js
+const body = {
+  "lineItems": [
+      {
+          "quantity": 1,
+          "amount": 5,
+          "currency": "USD",
+          "name": "T-Shirt",
+          "description": "White T-Shirt"
+      }
+  ],
+  "orderId": 22
+}
+
+const value = await Payments.createSession(body)
+```
+
+> This method creation of a payment session. It returns a Promise that resolves to a payment session object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "updatedDate": "2024-04-10T16:39:04.297Z",
+  "version": 10,
+  "identifier": "catalog",
+  "type": "session",
+  "lineItems": [
+    {
+      "quantity": 1,
+      "amount": 5,
+      "currency": "USD",
+      "name": "T-shirt",
+      "description": "White T-shirt"
+    }
+  ],
+  "orderId": 1,
+  "paymentAccountId": 1,
+  "status": "completed",
+  "sessionId": "9BE88048TU058770M",
+  "paymentUrl": "https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M",
+  "successUrl": "https://example.com/success",
+  "cancelUrl": "https://example.com/cancel",
+  "intent": {
+    "amount": 1,
+    "currency": "usd"
+  },
+  "intentId": 1,
+  "clientSecret": "pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2"
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**updatedDate:** string <br>
+*object modification date* <br>
+
+**version:**	number <br>
+*object modification version number* <br>
+example: 10 <br>
+
+**identifier:**	string <br>
+*text identifier for the record field* <br>
+example: catalog <br>
+
+**type:**	string <br>
+*type may be 'session' or 'intent'* <br>
+example: session <br>
+
+**lineItems:**	array <br>
+*list of items* <br>
+
+**orderId:**	number <br>
+*order identifier* <br>
+example: 1 <br>
+
+**paymentAccountId:**	number <br>
+*payment account object identifier* <br>
+example: 1 <br>
+
+**status:** string <br>
+*payment status* <br>
+example: completed <br>
+
+**sessionId:** string <br>
+*Payment ID from an external provider* <br>
+example: 9BE88048TU058770M <br>
+
+**paymentUrl:** string <br>
+*payment link* <br>
+example: https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M <br>
+
+**successUrl:**	string <br>
+*redirect link after successful payment* <br>
+example: https://example.com/success <br>
+
+**cancelUrl**	string <br>
+*redirect link after payment cancellation* <br>
+example:  https://example.com/cancel <br>
+
+**intent**	string <br>
+example:  { "amount": 1, "currency": "usd" } <br>
+
+**intentId**	number <br>
+*intent object identifier* <br>
+example:  1 <br>
+
+**clientSecret**	string <br>
+*client secret key* <br>
+example:  pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2 <br>
+
+</details>
+
+
+### Payments.getConnected()
+
+```js
+const value = await Payments.getConnected()
+```
+
+> This method get payment settings. It returns a Promise that resolves to a payment connection object.
+
+Example return:
+
+```json
+{
+  "stripeAccountId": "acct_1OtRiIHTHOaLRCAa",
+  "stripePublishableKey": "pk_51OOvk2HPDnVW5KWJwZfiYAlTLAytYqYYKYjGkxm6PqDD4BATCwuRDGgVYXNCqnvwrewgtDVaGyju5VfClW3GrxxT005KnY7MS3",
+  "paypalAccountId": "4Q0BANTF5BE7N"
+}
+```
+<details>
+<summary>Schema</summary>
+
+**stripeAccountId:**	string <br>
+*Identifier of connected Stripe account* <br>
+example: acct_1OtRiIHTHOaLRCAa <br>
+
+**stripePublishableKey:**	string <br>
+*Stripe Connect public key* <br>
+example: pk_51OOvk2HPDnVW5KWJwZfiYAlTLAytYqYYKYjGkxm6PqDD4BATCwuRDGgVYXNCqnvwrewgtDVaGyju5VfClW3GrxxT005KnY7MS3 <br>
+
+**paypalAccountId:**	string <br>
+*Identifier of connected Paypal account* <br>
+example: 4Q0BANTF5BE7N <br>
+
+</details>
+
+
+### Payments.getAccounts()
+
+```js
+const value = await Payments.getAccounts()
+```
+
+> This method get payment account as an array. It returns a Promise that resolves to a payment account object.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "updatedDate": "2024-04-10T17:02:20.707Z",
+    "version": 10,
+    "identifier": "catalog",
+    "localizeInfos": {
+        "title": "Stripe"
+    },
+    "type": "stripe",
+    "isVisible": true
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**updatedDate:**	string <br>
+*object modification date* <br>
+
+**version:**	number <br>
+*object modification version number* <br>
+example: 10 <br>
+
+**identifier:**	string <br>
+*text identifier for the recording field* <br>
+example: catalog <br>
+
+**localizeInfos:**	Record<string, any> <br>
+*json description of the main page data object taking into account the language "en_US" (for example)* <br>
+example: OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } <br>
+
+**type:**	string <br>
+*type may be 'stripe', 'paypal' or 'custom'* <br>
+example: stripe <br>
+
+**isVisible:**	boolean <br>
+*visibility indicator of the payment account* <br>
+example: true <br>
+
+</details>
+
+
+### Payments.getAccountById()
+
+```js
+const value = await Payments.getAccountById(1764)
+```
+
+> This method get a single payment account object by its identifier. It returns a Promise that resolves to a payment account object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "updatedDate": "2024-04-10T17:12:20.233Z",
+  "version": 10,
+  "identifier": "catalog",
+  "localizeInfos": {
+    "en_US": {
+      "title": "Stripe"
+    }
+  },
+  "type": "stripe",
+  "isVisible": true
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**updatedDate:**	string <br>
+*object modification date* <br>
+
+**version:**	number <br>
+*object modification version number* <br>
+example: 10 <br>
+
+**identifier:**	string <br>
+*text identifier for the recording field* <br>
+example: catalog <br>
+
+**localizeInfos:**	Record<string, any> <br>
+*json description of the main page data object taking into account the language "en_US" (for example)* <br>
+example: OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } <br>
+
+**type:**	string <br>
+*type may be 'stripe', 'paypal' or 'custom'* <br>
+example: stripe <br>
+
+**isVisible:**	boolean <br>
+*visibility indicator of the payment account* <br>
+example: true <br>
+
+</details>
+
+
+### Payments.webhookStripe()
+
+```js
+const value = await Payments.webhookStripe()
+```
+
+> This method use webhook for Stripe. Returns true (in case of successful execution) or false (in case of unsuccessful execution).
+
+
+
+### Payments.webhookStripe()
+
+```js
+const value = await Payments.webhookPaypal()
+```
+
+> This method use webhook for Paypal. Returns true (in case of successful execution) or false (in case of unsuccessful execution).
+
+---
+
+
 ## <h2 id="products"> Products </h2>
 
 

package/dist/index.d.ts

@@ -15,6 +15,8 @@ import BlocksApi from "./blocks/blocksApi";
 import AttributesSetsApi from "./attribute-sets/attributeSetsApi";
 import MarkersApi from "./markers/markersApi";
 import { IConfig } from "./base/utils";
+import OrdersApi from "./orders/ordersApi";
+import PaymentsApi from "./payments/paymentsApi";
 interface IDefineApi {
     Admins: AdminsApi;
     AttributesSets: AttributesSetsApi;
@@ -26,7 +28,9 @@ interface IDefineApi {
     Locales: LocalesApi;
     Markers: MarkersApi;
     Menus: MenusApi;
+    Orders: OrdersApi;
     Pages: PageApi;
+    Payments: PaymentsApi;
     Products: ProductApi;
     ProductStatuses: ProductStatusesApi;
     System: SystemApi;

package/dist/index.js

@@ -17,6 +17,8 @@ const systemApi_1 = require("./system/systemApi");
 const blocksApi_1 = require("./blocks/blocksApi");
 const attributeSetsApi_1 = require("./attribute-sets/attributeSetsApi");
 const markersApi_1 = require("./markers/markersApi");
+const ordersApi_1 = require("./orders/ordersApi");
+const paymentsApi_1 = require("./payments/paymentsApi");
 /**
  * Define API.
  * @param {string} url - URl of your project.
@@ -36,7 +38,9 @@ function defineOneEntry(url, config) {
     const Locales = new localesApi_1.default(url, config);
     const Markers = new markersApi_1.default(url, config);
     const Menus = new menusApi_1.default(url, config);
+    const Orders = new ordersApi_1.default(url, config);
     const Pages = new pagesApi_1.default(url, config);
+    const Payments = new paymentsApi_1.default(url, config);
     const Products = new productsApi_1.default(url, config);
     const ProductStatuses = new productStatusesApi_1.default(url, config);
     const System = new systemApi_1.default(url, config);
@@ -53,7 +57,9 @@ function defineOneEntry(url, config) {
         Locales,
         Markers,
         Menus,
+        Orders,
         Pages,
+        Payments,
         Products,
         ProductStatuses,
         System,

package/dist/orders/ordersApi.d.ts

@@ -0,0 +1,54 @@
+import OneEntry from "../base/oneEntry";
+import { IConfig } from "../base/utils";
+import { IOrdersApi, IOrdersEntity, IBaseOrdersEntity, IOrderData } from "./ordersInterfaces";
+/**
+ * Controllers for working with orders
+ */
+export default class OrdersApi extends OneEntry implements IOrdersApi {
+    constructor(url: string, config: IConfig);
+    /**
+     * Retrieve one order storage object by marker.
+     *
+     * @param {string} marker - Marker of the order object
+     * @param {string} [langCode] - Language code
+     *
+     * @returns Return object of order information.
+     */
+    getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity>;
+    /**
+     * Creation of an order in the order storage.
+     *
+     * @param {string} marker - Textual identifier of the order storage object
+     * @param {IOrderData} data - Object for creating an order
+     *
+     * @example
+     * {
+     *   "formIdentifier": "bar-orders-form",
+     *   "paymentIdentifier": "usd-payment",
+     *   "formData": {
+     *     "en_US": [
+     *       {
+     *         "marker": "name_1",
+     *         "value": "Name"
+     *       }
+     *     ]
+     *   },
+     *   "products": [
+     *     {
+     *       "productId": 1,
+     *       "quantity": 2,
+     *       "price": "23.02"
+     *     },
+     *     {
+     *       "productId": 2,
+     *       "quantity": 3,
+     *       "price": "3.02"
+     *     }
+     *   ],
+     *   "currency": "USD"
+     * }
+     *
+     * @returns Returns object for creating an order.
+     */
+    createOrder(marker: string, data: IOrderData): Promise<IBaseOrdersEntity>;
+}

package/dist/orders/ordersApi.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const oneEntry_1 = require("../base/oneEntry");
+/**
+ * Controllers for working with orders
+ */
+class OrdersApi extends oneEntry_1.default {
+    constructor(url, config) {
+        super(url, config);
+        this._url += '/api/content/orders-storage';
+    }
+    /**
+     * Retrieve one order storage object by marker.
+     *
+     * @param {string} marker - Marker of the order object
+     * @param {string} [langCode] - Language code
+     *
+     * @returns Return object of order information.
+     */
+    async getOrderByMarker(marker, langCode = this._defaultLangCode) {
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        return this._normalizeData(result);
+    }
+    /**
+     * Creation of an order in the order storage.
+     *
+     * @param {string} marker - Textual identifier of the order storage object
+     * @param {IOrderData} data - Object for creating an order
+     *
+     * @example
+     * {
+     *   "formIdentifier": "bar-orders-form",
+     *   "paymentIdentifier": "usd-payment",
+     *   "formData": {
+     *     "en_US": [
+     *       {
+     *         "marker": "name_1",
+     *         "value": "Name"
+     *       }
+     *     ]
+     *   },
+     *   "products": [
+     *     {
+     *       "productId": 1,
+     *       "quantity": 2,
+     *       "price": "23.02"
+     *     },
+     *     {
+     *       "productId": 2,
+     *       "quantity": 3,
+     *       "price": "3.02"
+     *     }
+     *   ],
+     *   "currency": "USD"
+     * }
+     *
+     * @returns Returns object for creating an order.
+     */
+    async createOrder(marker, data) {
+        const result = await this._fetchPost(`/marker/${marker}/order`, data);
+        return this._normalizeData(result);
+    }
+}
+exports.default = OrdersApi;

package/dist/orders/ordersInterfaces.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Represents an interface object of Orders Api.
+ *
+ * @property {function} getOrderByMarker - Retrieve one order storage object by marker.
+ * @property {function} createOrder - Creation of an order in the order storage.
+
+ */
+interface IOrdersApi {
+    getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity>;
+    createOrder(marker: string, data: IOrderData): Promise<IBaseOrdersEntity>;
+}
+interface IPicture {
+    filename: string;
+    downloadLink: string;
+    size: number;
+    previewLink: string;
+}
+interface IOrderProducts {
+    id: number;
+    title: string;
+    sku: string | null;
+    price: string | null;
+    quantity: number | null;
+    previewImage: Array<IPicture>;
+}
+interface IOrdersFormData {
+    marker: string;
+    value: string;
+}
+/**
+ * @interface
+ * @property {string} statusIdentifier - Text identifier of the order status.
+ * @property {string} formIdentifier - Text identifier of the form status.
+ * @property {string} paymentIdentifier - Text identifier of the order payment.
+ * @property {Array<IOrdersFormData>} formData - Data submitted by the form linked to the order store.
+ * @property {Array<IOrderProducts>} products - Array of products added to order.
+ * @property {string} totalSum - Total order amount.
+ * @property {string} currency - Currency used to pay for the order.
+ * @property {string} createdDate - Date when the order was created.
+ * @property {number} price - Price of the product per unit (at the time of ordering).
+ * @property {string} paymentAccountIdentifier - Textual identifier for the order payment.
+ * @property {Record<string, any>} paymentAccountLocalizeInfos - Payment account name considering localization.
+ */
+interface IBaseOrdersEntity {
+    statusIdentifier: string;
+    formIdentifier: string;
+    paymentIdentifier: string;
+    formData: Array<IOrdersFormData>;
+    products: Array<IOrderProducts>;
+    totalSum: string;
+    currency: string;
+    createdDate: string;
+    price: number;
+    paymentAccountIdentifier: string;
+    paymentAccountLocalizeInfos: Record<string, any>;
+}
+/**
+ * @interface
+ * @property {number} id - Object identifier.
+ * @property {Record<string, any>} localizeInfos - Name considering localization.
+ * @property {string} identifier - Textual identifier for the record field.
+ * @property {number} generalTypeId - Type identifier.
+ * @property {string} formIdentifier - Textual identifier for the form used by the order storage.
+ * @property {Array<{identifier:string}>} paymentAccountIdentifiers - Array of textual identifiers of payment accounts used by the order storage.
+ */
+interface IOrdersEntity {
+    id: number;
+    localizeInfos: Record<string, any>;
+    identifier: string | null;
+    generalTypeId: number | null;
+    formIdentifier: string | null;
+    paymentAccountIdentifiers: Array<{
+        identifier: string;
+    }>;
+}
+interface IOrderMarkerData {
+    marker: string;
+    value: string;
+}
+/**
+ * @interface
+ * @property {number} productId - Product identifier.
+ * @property {number} quantity - Quantity of the product.
+ * @property {string} price - Price per unit of the product.
+ */
+interface IOrderProductData {
+    productId: number;
+    quantity: number;
+    price: string;
+}
+/**
+ * @interface
+ * @property {string} formIdentifier - Text identifier of the form object linked to the order repository.
+ * @property {string} paymentIdentifier - Text identifier of the payment object linked to the order repository.
+ * @property {string} [statusIdentifier] - Text identifier of the order status object (if not specified, the default status will be assigned).
+ * @property {Record<string, Array<IOrderMarkerData>>} formData - Form data linked to the order repositor.
+ * @property {Array<IOrderProductData>} products - An array of ordered products.
+ * @property {string} currency - Currency used for order paymen.
+ */
+interface IOrderData {
+    formIdentifier: string;
+    paymentIdentifier: string;
+    statusIdentifier?: string;
+    formData: Record<string, Array<IOrderMarkerData>>;
+    products: Array<IOrderProductData>;
+    currency: string;
+}
+export { IOrdersEntity, IBaseOrdersEntity, IOrderProducts, IPicture, IOrdersApi, IOrderData, IOrderProductData, IOrderMarkerData, IOrdersFormData };

package/dist/orders/ordersInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/pages/pagesInterfaces.d.ts

@@ -147,7 +147,7 @@ interface IPagesEntity {
     parentId: number | null;
     position?: number;
     products?: number;
-    templateIdentifier: string;
+    templateIdentifier: string | null;
     type: Types;
 }
 export { IPageApi, IPageConfig, IPagesEntity, IPositionForm, IPositionBlock };

package/dist/payments/paymentsApi.d.ts

@@ -0,0 +1,80 @@
+import OneEntry from "../base/oneEntry";
+import { IConfig } from "../base/utils";
+import { IPaymentsApi, ISessionEntity, IConnectedEntity, IAccountsEntity, ISessionBody } from "./paymentsInterfaces";
+/**
+ * Controllers for working with payments
+ */
+export default class PaymentsApi extends OneEntry implements IPaymentsApi {
+    constructor(url: string, config: IConfig);
+    /**
+     * Get list of payment sessions.
+     *
+     * @param {number} [limit] - Optional parameter for pagination, default is 0
+     * @param {number} [offset] - Optional parameter for pagination, default is 30
+     *
+     * @returns Returns an array of SessionEntity objects.
+     */
+    getSessions(limit?: number, offset?: number): Promise<Array<ISessionEntity>>;
+    /**
+     * Get a single payment session object by its identifier.
+     *
+     * @param {number} id - Identifier of the retrieved payment session object
+     *
+     * @returns Returns a single payment session object.
+     */
+    getSessionById(id: number): Promise<ISessionEntity>;
+    /**
+     * Creation of payment session.
+     *
+     * @param {ISessionBody} body - Object for creating a payment
+     *
+     * @example
+     * {
+     *     "lineItems": [
+     *         {
+     *           "quantity": 1,
+     *           "amount": 5,
+     *           "currency": "USD",
+     *           "name": "T-Shirt",
+     *           "description": "White T-Shirt"
+     *         }
+     *     ],
+     *     "orderId": 22
+     *   }
+     *
+     * @returns Returns a single payment session object.
+     */
+    createSession(body: ISessionBody): Promise<ISessionEntity>;
+    /**
+     * Get payment settings.
+     *
+     * @returns Returns object PaymentsConnected or null.
+     */
+    getConnected(): Promise<IConnectedEntity | null>;
+    /**
+     * Get all payment accounts as an array.
+     *
+     * @returns Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     */
+    getAccounts(): Promise<Array<IAccountsEntity>>;
+    /**
+     * Get a single payment account object by its identifier.
+     *
+     * @param {number} id - Identifier of the retrieved payment account object
+     *
+     * @returns Returns a single payment account object.
+     */
+    getAccountById(id: number): Promise<IAccountsEntity>;
+    /**
+     * Webhook for Stripe.
+     *
+     * @returns Returns true (in case of successful execution) or false (in case of unsuccessful execution)
+     */
+    webhookStripe(): Promise<boolean>;
+    /**
+     * Webhook for Paypal.
+     *
+     * @returns Returns true (in case of successful execution) or false (in case of unsuccessful execution)
+     */
+    webhookPaypal(): Promise<boolean>;
+}

package/dist/payments/paymentsApi.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const oneEntry_1 = require("../base/oneEntry");
+/**
+ * Controllers for working with payments
+ */
+class PaymentsApi extends oneEntry_1.default {
+    constructor(url, config) {
+        super(url, config);
+        this._url += '/api/content/payments';
+    }
+    /**
+     * Get list of payment sessions.
+     *
+     * @param {number} [limit] - Optional parameter for pagination, default is 0
+     * @param {number} [offset] - Optional parameter for pagination, default is 30
+     *
+     * @returns Returns an array of SessionEntity objects.
+     */
+    async getSessions(limit = 30, offset = 0) {
+        const result = await this._fetchGet('/sessions');
+        return result.items;
+    }
+    /**
+     * Get a single payment session object by its identifier.
+     *
+     * @param {number} id - Identifier of the retrieved payment session object
+     *
+     * @returns Returns a single payment session object.
+     */
+    async getSessionById(id) {
+        const result = await this._fetchGet(`/sessions/${id}`);
+        return result;
+    }
+    /**
+     * Creation of payment session.
+     *
+     * @param {ISessionBody} body - Object for creating a payment
+     *
+     * @example
+     * {
+     *     "lineItems": [
+     *         {
+     *           "quantity": 1,
+     *           "amount": 5,
+     *           "currency": "USD",
+     *           "name": "T-Shirt",
+     *           "description": "White T-Shirt"
+     *         }
+     *     ],
+     *     "orderId": 22
+     *   }
+     *
+     * @returns Returns a single payment session object.
+     */
+    async createSession(body) {
+        const result = await this._fetchPost('/sessions', body);
+        return result;
+    }
+    /**
+     * Get payment settings.
+     *
+     * @returns Returns object PaymentsConnected or null.
+     */
+    async getConnected() {
+        const result = await this._fetchGet('/connected');
+        return result;
+    }
+    /**
+     * Get all payment accounts as an array.
+     *
+     * @returns Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     */
+    async getAccounts() {
+        const result = await this._fetchGet('/accounts');
+        return this._normalizeData(result);
+    }
+    /**
+     * Get a single payment account object by its identifier.
+     *
+     * @param {number} id - Identifier of the retrieved payment account object
+     *
+     * @returns Returns a single payment account object.
+     */
+    async getAccountById(id) {
+        const result = await this._fetchGet(`/accounts/${id}`);
+        return result;
+    }
+    /**
+     * Webhook for Stripe.
+     *
+     * @returns Returns true (in case of successful execution) or false (in case of unsuccessful execution)
+     */
+    async webhookStripe() {
+        const result = await this._fetchPost('/webhook/stripe', null);
+        return result;
+    }
+    /**
+     * Webhook for Paypal.
+     *
+     * @returns Returns true (in case of successful execution) or false (in case of unsuccessful execution)
+     */
+    async webhookPaypal() {
+        const result = await this._fetchPost('/webhook/paypal', null);
+        return result;
+    }
+}
+exports.default = PaymentsApi;

package/dist/payments/paymentsInterfaces.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Represents an interface object of Orders Api.
+ *
+ * @property {function} getSessions - Get list of payment sessions.
+ * @property {function} getSessionById - Get a single payment session object by its identifier.
+ * @property {function} createSession - Creation of payment session.
+ * @property {function} getConnected - Get payment settings.
+ * @property {function} getAccounts - Get all payment accounts as an array.
+ * @property {function} getAccountById - Get a single payment account object by its identifier.
+ * @property {function} webhookStripe - Webhook for Stripe.
+ * @property {function} webhookPaypal - Webhook for Paypal.
+ *
+ */
+interface IPaymentsApi {
+    getSessions(limit: number, offset: number): Promise<Array<ISessionEntity>>;
+    getSessionById(id: number): Promise<ISessionEntity>;
+    createSession(body: ISessionBody): Promise<ISessionEntity>;
+    getConnected(): Promise<IConnectedEntity | null>;
+    getAccounts(): Promise<Array<IAccountsEntity>>;
+    getAccountById(id: number): Promise<IAccountsEntity>;
+    webhookStripe(): Promise<boolean>;
+    webhookPaypal(): Promise<boolean>;
+}
+/**
+ *
+ * @interface
+ * @property {number} quantity - Quantity information.
+ * @property {number} amount - Amount information.
+ * @property {string} currency - Currency information.
+ * @property {string} name - Name.
+ * @property {string} description - Description.
+ */
+interface ILineItems {
+    quantity: number;
+    amount: number;
+    currency: string;
+    name: string;
+    description: string;
+}
+/**
+ * @interface
+ * @property {Array<ILineItems>} lineItems - List of items.
+ * @property {number} orderId - Order identifier.
+ */
+interface ISessionBody {
+    lineItems: Array<ILineItems>;
+    orderId: number;
+}
+/**
+ * @interface
+ * @property {number} amount
+ * @property {string} currency
+ */
+interface IIntent {
+    amount: number;
+    currency: string;
+}
+/**
+ * @interface
+ * @property {number} id - Object identifier.
+ * @property {string} updatedDate - Object modification date.
+ * @property {number} version - Object modification version number.
+ * @property {string} identifier - Text identifier for the record field.
+ * @property {string} type - Type may be 'session' or 'intent'.
+ * @property {number} orderId - Order identifier.
+ * @property {number} paymentAccountId - Payment account object identifier.
+ * @property {string} status - Payment status.
+ * @property {string} sessionId - Payment ID from an external provider.
+ * @property {string} paymentUrl - Payment link.
+ * @property {string} successUrl - Redirect link after successful payment.
+ * @property {string} cancelUrl - Redirect link after payment cancellation.
+ * @property {IIntent} intent - Payment intent.
+ * @property {number} intentId - Intent object identifier.
+ * @property {string} clientSecret - Client secret key.
+ */
+interface ISessionEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    type: 'session' | 'intent';
+    lineItems: Array<ILineItems>;
+    orderId: number;
+    paymentAccountId: number;
+    status: string;
+    sessionId: string;
+    paymentUrl: string;
+    successUrl: string;
+    cancelUrl: string;
+    intent: IIntent;
+    intentId: number;
+    clientSecret: string;
+}
+/**
+ * @interface
+ * @property {string} [stripeAccountId] - Identifier of connected Stripe account.
+ * @property {string} [stripePublishableKey] - Stripe Connect public key.
+ * @property {string} [paypalAccountId] - Identifier of connected Paypal account.
+ */
+interface IConnectedEntity {
+    stripeAccountId?: string;
+    stripePublishableKey?: string;
+    paypalAccountId?: string;
+}
+/**
+ * @interface
+ * @property {number} id - Object identifier.
+ * @property {string} updatedDate - Object modification date.
+ * @property {number} version - Object modification version number.
+ * @property {string} identifier - Text identifier for the recording field.
+ * @property {Record<string, any>} localizeInfos - Json description of the payment account object.
+ * @property {string} type - Type may be 'stripe', 'paypal' or 'custom'.
+ * @property {boolean} isVisible - Visibility indicator of the payment account.
+ */
+interface IAccountsEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    localizeInfos: Record<string, any>;
+    type: 'stripe' | 'paypal' | 'custom';
+    isVisible: boolean;
+}
+export { IAccountsEntity, IConnectedEntity, ISessionEntity, ILineItems, ISessionBody, IPaymentsApi, IIntent };

package/dist/payments/paymentsInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.59",
+  "version": "1.0.60",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",