@epilot/pricing-client 3.9.2 → 3.11.0

package/dist/openapi.d.ts

@@ -2624,7 +2624,7 @@ declare namespace Components {
              */
             msg: string;
             /**
-             * Data related with the error
+             * Data related to the error
              */
             data?: string;
         }

package/dist/openapi.json

@@ -66,15 +66,24 @@
   "x-tagGroups": [
     {
       "name": "Commerce Schemas",
-      "tags": ["order_schema", "opportunity_schema"]
+      "tags": [
+        "order_schema",
+        "opportunity_schema"
+      ]
     },
     {
       "name": "Pricing Schemas",
-      "tags": ["product_schema", "simple_price_schema", "dynamic_price_schema"]
+      "tags": [
+        "product_schema",
+        "simple_price_schema",
+        "dynamic_price_schema"
+      ]
     },
     {
       "name": "Examples",
-      "tags": ["order_composite_prices"]
+      "tags": [
+        "order_composite_prices"
+      ]
     },
     {
       "name": "APIs",
@@ -106,7 +115,9 @@
         "description": "Create an order",
         "operationId": "createOrder",
         "summary": "createOrder",
-        "tags": ["Order API"],
+        "tags": [
+          "Order API"
+        ],
         "requestBody": {
           "required": true,
           "content": {
@@ -172,7 +183,9 @@
                     "delivery_address": [],
                     "dates": [
                       {
-                        "_tags": ["Instalation Date"],
+                        "_tags": [
+                          "Instalation Date"
+                        ],
                         "dates": "",
                         "value": "2022-06-30T16:29:00.000Z"
                       }
@@ -236,7 +249,9 @@
                     "delivery_address": [],
                     "dates": [
                       {
-                        "_tags": ["Instalation Date"],
+                        "_tags": [
+                          "Instalation Date"
+                        ],
                         "dates": "",
                         "value": "2022-06-30T16:29:00.000Z"
                       }
@@ -309,7 +324,9 @@
                     "delivery_address": [],
                     "dates": [
                       {
-                        "_tags": ["Instalation Date"],
+                        "_tags": [
+                          "Instalation Date"
+                        ],
                         "dates": "",
                         "value": "2022-06-30T16:29:00.000Z"
                       }
@@ -352,7 +369,9 @@
         "description": "Update an existing Order",
         "operationId": "putOrder",
         "summary": "putOrder",
-        "tags": ["Order API"],
+        "tags": [
+          "Order API"
+        ],
         "parameters": [
           {
             "in": "path",
@@ -433,7 +452,9 @@
                     "delivery_address": [],
                     "dates": [
                       {
-                        "_tags": ["Instalation Date"],
+                        "_tags": [
+                          "Instalation Date"
+                        ],
                         "dates": "",
                         "value": "2022-06-30T16:29:00.000Z"
                       }
@@ -474,7 +495,9 @@
         "operationId": "$checkoutCart",
         "summary": "checkoutCart",
         "security": [],
-        "tags": ["Cart API"],
+        "tags": [
+          "Cart API"
+        ],
         "parameters": [
           {
             "in": "header",
@@ -536,7 +559,9 @@
         "operationId": "$searchCatalog",
         "summary": "searchCatalog",
         "security": [],
-        "tags": ["Catalog API"],
+        "tags": [
+          "Catalog API"
+        ],
         "parameters": [
           {
             "in": "header",
@@ -588,7 +613,9 @@
         "operationId": "$availabilityCheck",
         "summary": "availabilityCheck",
         "security": [],
-        "tags": ["Availability API"],
+        "tags": [
+          "Availability API"
+        ],
         "parameters": [
           {
             "in": "header",
@@ -610,7 +637,9 @@
               "examples": {
                 "Check availability with location dimension": {
                   "value": {
-                    "products": ["cd75456a-30e4-4912-95be-e743d5ea175b"],
+                    "products": [
+                      "cd75456a-30e4-4912-95be-e743d5ea175b"
+                    ],
                     "filters": {
                       "location": {
                         "postal_code": "57008",
@@ -623,7 +652,9 @@
                 },
                 "Check availability with location & available date dimension": {
                   "value": {
-                    "products": ["cd75456a-30e4-4912-95be-e743d5ea175b"],
+                    "products": [
+                      "cd75456a-30e4-4912-95be-e743d5ea175b"
+                    ],
                     "filters": {
                       "location": {
                         "postal_code": "57008",
@@ -668,7 +699,9 @@
                   },
                   "Response with available and unavailable products": {
                     "value": {
-                      "availableProducts": ["my-product-id-123-2"],
+                      "availableProducts": [
+                        "my-product-id-123-2"
+                      ],
                       "checkResults": [
                         {
                           "productId": "my-product-id-123-1",
@@ -705,7 +738,9 @@
         "description": "Validates an availability file, it returns an array of errors if the file is invalid",
         "operationId": "$validateAvailabilityFile",
         "summary": "validateAvailabilityFile",
-        "tags": ["Availability API"],
+        "tags": [
+          "Availability API"
+        ],
         "parameters": [
           {
             "in": "path",
@@ -776,7 +811,9 @@
         "operationId": "$createOpportunity",
         "summary": "createOpportunity",
         "security": [],
-        "tags": ["Deprecated"],
+        "tags": [
+          "Deprecated"
+        ],
         "parameters": [
           {
             "in": "header",
@@ -818,11 +855,16 @@
                       "$relation": [
                         {
                           "entity_id": "c8dbe8f3-28b6-4d77-aae8-47bc24a2532f",
-                          "_tags": ["journey"]
+                          "_tags": [
+                            "journey"
+                          ]
                         }
                       ]
                     },
-                    "_tags": ["journey", "ORWNr4iCN"]
+                    "_tags": [
+                      "journey",
+                      "ORWNr4iCN"
+                    ]
                   }
                 }
               }
@@ -864,7 +906,9 @@
     },
     "schemas": {
       "Error": {
-        "required": ["message"],
+        "required": [
+          "message"
+        ],
         "properties": {
           "message": {
             "type": "string",
@@ -900,7 +944,10 @@
           "type": {
             "type": "string",
             "description": "The type of Product:\n\n| type | description |\n|----| ----|\n| `product` | Represents a physical good |\n| `service` | Represents a service or virtual product |\n",
-            "enum": ["product", "service"]
+            "enum": [
+              "product",
+              "service"
+            ]
           },
           "name": {
             "type": "string",
@@ -1497,7 +1544,10 @@
           "type": {
             "type": "string",
             "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
-            "enum": ["one_time", "recurring"]
+            "enum": [
+              "one_time",
+              "recurring"
+            ]
           },
           "billing_period": {
             "description": "For recurring prices `billing_period` defines the default extent of the recurrence.",
@@ -1539,7 +1589,11 @@
           "billing_duration_unit": {
             "description": "The billing period duration unit",
             "type": "string",
-            "enum": ["weeks", "months", "years"]
+            "enum": [
+              "weeks",
+              "months",
+              "years"
+            ]
           },
           "notice_time_amount": {
             "description": "The notice period duration",
@@ -1548,7 +1602,11 @@
           "notice_time_unit": {
             "description": "The notice period duration unit",
             "type": "string",
-            "enum": ["weeks", "months", "years"]
+            "enum": [
+              "weeks",
+              "months",
+              "years"
+            ]
           },
           "termination_time_amount": {
             "description": "The termination period duration",
@@ -1557,7 +1615,11 @@
           "termination_time_unit": {
             "description": "The termination period duration unit",
             "type": "string",
-            "enum": ["weeks", "months", "years"]
+            "enum": [
+              "weeks",
+              "months",
+              "years"
+            ]
           },
           "renewal_duration_amount": {
             "description": "The renewal period duration",
@@ -1566,7 +1628,11 @@
           "renewal_duration_unit": {
             "description": "The renewal period duration unit",
             "type": "string",
-            "enum": ["weeks", "months", "years"]
+            "enum": [
+              "weeks",
+              "months",
+              "years"
+            ]
           },
           "variable_price": {
             "description": "The flag for prices that can be influenced by external variables such as user input.",
@@ -1628,7 +1694,9 @@
             }
           }
         },
-        "required": ["pricing_model"]
+        "required": [
+          "pricing_model"
+        ]
       },
       "CompositePrice": {
         "type": "object",
@@ -1857,7 +1925,9 @@
             }
           }
         },
-        "required": ["q"]
+        "required": [
+          "q"
+        ]
       },
       "CatalogSearchResult": {
         "description": "The query result payload",
@@ -1911,7 +1981,10 @@
             "$ref": "#/components/schemas/AvailabilityFilters"
           }
         },
-        "required": ["products", "filters"]
+        "required": [
+          "products",
+          "filters"
+        ]
       },
       "AvailabilityResult": {
         "description": "The availability check result payload",
@@ -1943,11 +2016,15 @@
                   "additionalProperties": true
                 }
               },
-              "required": ["product_id"]
+              "required": [
+                "product_id"
+              ]
             }
           }
         },
-        "required": ["available_products"],
+        "required": [
+          "available_products"
+        ],
         "example": {
           "available_products": [],
           "check_results": [
@@ -1975,11 +2052,13 @@
             "type": "string"
           },
           "data": {
-            "description": "Data related with the error",
+            "description": "Data related to the error",
             "type": "string"
           }
         },
-        "required": ["msg"]
+        "required": [
+          "msg"
+        ]
       },
       "ValidateAvailabilityFileResult": {
         "description": "The availability map file result payload",
@@ -1988,7 +2067,10 @@
           "status": {
             "description": "The status of the validation",
             "type": "string",
-            "enum": ["success", "error"]
+            "enum": [
+              "success",
+              "error"
+            ]
           },
           "rules_parsed_count": {
             "description": "The number of rules successfully parsed",
@@ -2002,7 +2084,11 @@
             }
           }
         },
-        "required": ["status", "rules_parsed_count", "errors"],
+        "required": [
+          "status",
+          "rules_parsed_count",
+          "errors"
+        ],
         "example": {
           "rules_parsed_count": 8,
           "errors": [
@@ -2078,7 +2164,9 @@
             "additionalProperties": true
           }
         },
-        "required": ["line_items"]
+        "required": [
+          "line_items"
+        ]
       },
       "CheckoutCart": {
         "type": "object",
@@ -2112,11 +2200,21 @@
       "CheckoutMode": {
         "type": "string",
         "description": "The checkout mode for the cart checkout.",
-        "enum": ["create_order", "create_invoice", "create_quote"]
+        "enum": [
+          "create_order",
+          "create_invoice",
+          "create_quote"
+        ]
       },
       "OrderStatus": {
         "type": "string",
-        "enum": ["draft", "quote", "placed", "cancelled", "completed"],
+        "enum": [
+          "draft",
+          "quote",
+          "placed",
+          "cancelled",
+          "completed"
+        ],
         "description": "\n| status      | description |\n|-------------|-------|\n| `draft`     | ​​Starting state for all orders, at this point we can still edit the order |\n| `quote`     | The order is in a quoting phase, bound to an expiration date |\n| `placed`    | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |\n| `cancelled` | The order has been cancelled |\n| `completed` | The order is now closed and finalized |\n"
       },
       "PriceItemsDto": {
@@ -2210,7 +2308,10 @@
           "type": {
             "type": "string",
             "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
-            "enum": ["one_time", "recurring"]
+            "enum": [
+              "one_time",
+              "recurring"
+            ]
           },
           "unit_amount": {
             "type": "integer",
@@ -2246,7 +2347,9 @@
             ]
           }
         },
-        "required": ["pricing_model"]
+        "required": [
+          "pricing_model"
+        ]
       },
       "CompositePriceItemDto": {
         "allOf": [
@@ -2344,7 +2447,10 @@
             "description": "Total of all items taxes, with same recurrence."
           }
         },
-        "required": ["amount_subtotal", "amount_total"]
+        "required": [
+          "amount_subtotal",
+          "amount_total"
+        ]
       },
       "Cart": {
         "description": "Supports shopping for products and services until ready for checkout.",
@@ -2359,7 +2465,11 @@
             "readOnly": true
           },
           "status": {
-            "enum": ["open", "complete", "expired"],
+            "enum": [
+              "open",
+              "complete",
+              "expired"
+            ],
             "type": "string",
             "readOnly": true,
             "description": "The status of the Cart:\n- open - the cart checkout is still in progress. Payment processing has not started\n- complete - the cart checkout is complete. Payment processing may still be in progress\n- expired - the cart checkout has expired. No further processing will occur\n"
@@ -2659,7 +2769,10 @@
           "type": {
             "type": "string",
             "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
-            "enum": ["one_time", "recurring"]
+            "enum": [
+              "one_time",
+              "recurring"
+            ]
           },
           "pricing_model": {
             "type": "string",
@@ -2672,7 +2785,9 @@
             ]
           }
         },
-        "required": ["pricing_model"]
+        "required": [
+          "pricing_model"
+        ]
       },
       "TaxAmount": {
         "type": "object",
@@ -2758,7 +2873,10 @@
             "description": "Total of all items taxes, with same recurrence."
           }
         },
-        "required": ["amount_subtotal", "amount_total"]
+        "required": [
+          "amount_subtotal",
+          "amount_total"
+        ]
       },
       "TotalDetails": {
         "type": "object",
@@ -2850,7 +2968,11 @@
       },
       "SalesTax": {
         "type": "string",
-        "enum": ["nontaxable", "reduced", "standard"]
+        "enum": [
+          "nontaxable",
+          "reduced",
+          "standard"
+        ]
       },
       "AvailabilityLocation": {
         "type": "object",
@@ -2908,7 +3030,9 @@
             "description": "A value to be matched against the availability window (start & end date)"
           }
         },
-        "required": ["location"]
+        "required": [
+          "location"
+        ]
       },
       "Address": {
         "type": "object",
@@ -2919,7 +3043,9 @@
             "items": {
               "type": "string"
             },
-            "example": ["billing"]
+            "example": [
+              "billing"
+            ]
           },
           "street": {
             "type": "string",
@@ -3046,10 +3172,15 @@
                       "type": "string"
                     }
                   },
-                  "required": ["bucket", "key"]
+                  "required": [
+                    "bucket",
+                    "key"
+                  ]
                 }
               },
-              "required": ["s3ref"]
+              "required": [
+                "s3ref"
+              ]
             }
           },
           "_schema": {
@@ -3132,7 +3263,10 @@
           "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
           "_org": "123",
           "_schema": "contact",
-          "_tags": ["example", "mock"],
+          "_tags": [
+            "example",
+            "mock"
+          ],
           "_created_at": "2021-02-09T12:41:43.662Z",
           "_updated_at": "2021-02-09T12:41:43.662Z"
         }
@@ -3197,7 +3331,11 @@
           },
           "type": {
             "type": "string",
-            "enum": ["VAT", "GST", "Custom"]
+            "enum": [
+              "VAT",
+              "GST",
+              "Custom"
+            ]
           },
           "description": {
             "type": "string"
@@ -3224,7 +3362,10 @@
           "region_label": "Germany",
           "_org": "123",
           "_schema": "tax",
-          "_tags": ["example", "mock"],
+          "_tags": [
+            "example",
+            "mock"
+          ],
           "_created_at": "2021-02-09T12:41:43.662Z",
           "_updated_at": "2021-02-09T12:41:43.662Z"
         }
@@ -3237,7 +3378,11 @@
           },
           "type": {
             "type": "string",
-            "enum": ["VAT", "GST", "Custom"]
+            "enum": [
+              "VAT",
+              "GST",
+              "Custom"
+            ]
           },
           "_id": {
             "type": "string"
@@ -3270,7 +3415,10 @@
       },
       "PriceTierDisplayMode": {
         "type": "string",
-        "enum": ["hidden", "on_request"]
+        "enum": [
+          "hidden",
+          "on_request"
+        ]
       }
     },
     "examples": {
@@ -3747,8 +3895,14 @@
                 "_id": "065d6618-cc59-45f4-8e3a-700edf6813c3",
                 "name": "Smartmeter: Schneider Electric PM5000 LCD Energiemessgerät / 3-phasig",
                 "code": "1312378123",
-                "_tags": ["wallbox", "review demo", "1"],
-                "categories": ["Power"],
+                "_tags": [
+                  "wallbox",
+                  "review demo",
+                  "1"
+                ],
+                "categories": [
+                  "Power"
+                ],
                 "type": "product",
                 "active": true,
                 "feature": [
@@ -3954,7 +4108,9 @@
           "delivery_address": [],
           "dates": [
             {
-              "_tags": ["Instalation Date"],
+              "_tags": [
+                "Instalation Date"
+              ],
               "dates": "",
               "value": "2022-06-30T16:29:00.000Z"
             }
@@ -4032,7 +4188,9 @@
           "delivery_address": [],
           "dates": [
             {
-              "_tags": ["Instalation Date"],
+              "_tags": [
+                "Instalation Date"
+              ],
               "dates": "",
               "value": "2022-06-30T16:29:00.000Z"
             }
@@ -4051,7 +4209,10 @@
               "value": "journey checkout"
             }
           ],
-          "_tags": ["journey", "automation"],
+          "_tags": [
+            "journey",
+            "automation"
+          ],
           "status": "quote",
           "order_number": "OREabZxnO",
           "billing_first_name": "Paulo",
@@ -4458,7 +4619,9 @@
           },
           "dates": [
             {
-              "_tags": ["Installation Date"],
+              "_tags": [
+                "Installation Date"
+              ],
               "dates": "",
               "value": "2022-06-30T15:21:00.000Z"
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/pricing-client",
-  "version": "3.9.2",
+  "version": "3.11.0",
   "description": "Client for epilot Pricing APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,7 @@
   "scripts": {
     "test": "jest",
     "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/pricing-api.yaml",
+    "openapi": "node ../../scripts/update-openapi.js /Users/paulohenriques/Documents/pricing-api/lambda/ApiHandlerFunction/openapi.yml",
     "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
     "build": "tsc && npm run bundle-definition",
     "build:watch": "npm run build && tsc -w",