oneentry 1.0.59 → 1.0.61

package/README.md

@@ -41,13 +41,13 @@ const {
         System,
         Templates,
         TemplatePreviews
-} = defineOneEntry('your-url')
+} = defineOneEntry('your-url');
 ```
 
 Or
 
 ```js
-const api = defineOneEntry('your-url')
+const api = defineOneEntry('your-url');
 ```
 
 The second parameter of the function takes a configuration object with the keys "token", "langCode" and "multipleResponse".
@@ -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)
@@ -96,7 +98,7 @@ Now you can use the following links to jump to specific entries:
 
 
 ```js
-const { Admins } = defineOneEntry('your-url')
+const { Admins } = defineOneEntry('your-url');
 ```
 
 ### Admins.getAdminsInfo(langCode, offset, limit)
@@ -623,7 +625,9 @@ Example return:
 
 ## <h2 id="fileuploading"> FileUploading </h2>
 
+```js
 const { FileUploading } = defineOneEntry('your-url');
+```
 
 ### FileUploading.upload(data, fileQuery)
 
@@ -707,7 +711,9 @@ Example return:
 ## <h2 id="forms"> Forms </h2>
 
 
+```js
 const { Forms } = defineOneEntry('your-url');
+```
 
 ### Forms.getAllForms(langCode, offset, limit)
 
@@ -915,15 +921,27 @@ example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "lis
 
 ## <h2 id="formdata"> FormData </h2>
 
+```js
 const { FormData } = defineOneEntry('your-url');
+```
 
-### FormData.postFormsData(data)
+### FormData.postFormsData(data, langCode)
 
 ```js
-const value = await FormData.postFormsData(data)
+const body = {
+    formIdentifier: 'test',
+    formData: {
+        marker: 'test',
+        value: 'Test',
+    },
+}
+
+const value = await FormData.postFormsData(body)
 ```
 
-> This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormDataDto.
+> This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormData. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument 
+
+
 
 Example return:
 
@@ -1061,7 +1079,9 @@ example: test-form <br>
 
 ## <h2 id="generaltypes"> GeneralTypes </h2>
 
+```js
 const { GeneralTypes } = defineOneEntry('your-url');
+```
 
 ### GeneralTypes.getAllTypes()
 
@@ -1101,7 +1121,7 @@ Enum:
 ## <h2 id="locales"> Locales </h2>
 
 ```js
-const { Locales } = defineOneEntry('your-url')
+const { Locales } = defineOneEntry('your-url');
 ```
 
 ### Locales.getLocales()
@@ -1172,7 +1192,7 @@ description:position number
 
 
 ```js
-const { Markers } = defineOneEntry('your-url')
+const { Markers } = defineOneEntry('your-url');
 ```
 
 ### Markers.getMarkers(offset, limit)
@@ -1401,11 +1421,206 @@ 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, langCode)
+
+```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. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
+
+Example return:
+```json
+{
+  "id": 17,
+  "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",
+  "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>
 
 
 ```js
-const { Pages } = defineOneEntry('your-url')
+const { Pages } = defineOneEntry('your-url');
 ```
 
 ### Pages.getRootPages(langCode)
@@ -2364,11 +2579,528 @@ 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>
 
 
 ```js
-const { Products } = defineOneEntry('your-url')
+const { Products } = defineOneEntry('your-url');
 ```
 
 >This module accepts a set of user parameters called userQuery. If the parameters are not passed to the method, the default value will be applied.
@@ -3459,7 +4191,7 @@ true
 
 
 ```js
-const { System } = defineOneEntry('your-url')
+const { System } = defineOneEntry('your-url');
 ```
 
 ### System.test404()
@@ -3483,7 +4215,7 @@ const value = await System.test500()
 
 
 ```js
-const { Templates } = defineOneEntry('your-url')
+const { Templates } = defineOneEntry('your-url');
 ```
 
 ### Templates.getAllTemplates()
@@ -3645,7 +4377,7 @@ general type name <br>
 
 
 ```js
-const { TemplatePreviews } = defineOneEntry('your-url')
+const { TemplatePreviews } = defineOneEntry('your-url');
 ```
 
 ### TemplatePreviews.getTemplatePreviews()