@flowio/api-internal-mock-generator 4.1.1 → 4.1.3

package/dist/api-internal.json

@@ -4986,7 +4986,7 @@
                     "annotations": [],
                     "attributes": [],
                     "type": "item_classification_status",
-                    "required": true
+                    "required": false
                 }, {
                     "default": "[]",
                     "name": "customs_description_suggestions",
@@ -5098,7 +5098,7 @@
                     "annotations": [],
                     "attributes": [],
                     "type": "item_classification_status",
-                    "required": true
+                    "required": false
                 }, {
                     "name": "suggestion_count",
                     "annotations": [],
@@ -11438,45 +11438,6 @@
                     "type": "map[decimal]",
                     "required": true
                 }]
-        }, {
-            "plural": "landed_cost_exports",
-            "name": "landed_cost_export",
-            "description": "Export landed cost items.",
-            "attributes": [],
-            "fields": [{
-                    "name": "event_id",
-                    "annotations": [],
-                    "attributes": [],
-                    "type": "string",
-                    "required": true
-                }, {
-                    "name": "timestamp",
-                    "annotations": [],
-                    "description": "The date/time of the request",
-                    "attributes": [],
-                    "type": "date-time-iso8601",
-                    "required": true
-                }, {
-                    "name": "organization",
-                    "annotations": [],
-                    "description": "Refers to your organization's account identifier",
-                    "attributes": [],
-                    "type": "string",
-                    "required": true
-                }, {
-                    "name": "export_id",
-                    "annotations": [],
-                    "attributes": [],
-                    "type": "string",
-                    "required": true
-                }, {
-                    "name": "items",
-                    "annotations": [],
-                    "description": "The list of item numbers to include in the export",
-                    "attributes": [],
-                    "type": "[landed_cost_item]",
-                    "required": true
-                }]
         }, {
             "plural": "landed_cost_items",
             "name": "landed_cost_item",
@@ -17358,12 +17319,14 @@
                 }, {
                     "name": "current_customs_description",
                     "annotations": [],
+                    "description": "the previous customs description in case the product was previously classified",
                     "attributes": [],
                     "type": "string",
                     "required": false
                 }, {
                     "name": "customs_description",
                     "annotations": [],
+                    "description": "the customs description just computed by the classification model, if any",
                     "attributes": [],
                     "type": "string",
                     "required": false
@@ -17392,6 +17355,13 @@
             "name": "product_classification_form",
             "attributes": [],
             "fields": [{
+                    "name": "initial_customs_description",
+                    "annotations": [],
+                    "description": "Custom Description that was sent upon page load (if present)",
+                    "attributes": [],
+                    "type": "string",
+                    "required": false
+                }, {
                     "name": "product_harmonization",
                     "annotations": [],
                     "attributes": [],
@@ -17403,12 +17373,6 @@
                     "attributes": [],
                     "type": "string",
                     "required": true
-                }, {
-                    "name": "action",
-                    "annotations": [],
-                    "attributes": [],
-                    "type": "product_classification_action",
-                    "required": true
                 }]
         }, {
             "plural": "product_classification_judgement_forms",
@@ -22132,7 +22096,7 @@
                     "name": "status",
                     "annotations": [],
                     "attributes": [],
-                    "type": "unclassified_product_status",
+                    "type": "item_classification_status",
                     "required": false
                 }]
         }, {
@@ -22939,14 +22903,6 @@
                     "discriminator_value": "unharmonized_items_export",
                     "attributes": [],
                     "type": "unharmonized_items_export"
-                }, {
-                    "discriminator_value": "dutied_items_export",
-                    "attributes": [],
-                    "type": "dutied_items_export"
-                }, {
-                    "discriminator_value": "landed_cost_export",
-                    "attributes": [],
-                    "type": "landed_cost_export"
                 }, {
                     "discriminator_value": "harmonization_phrase_suggestion_request_import",
                     "attributes": [],
@@ -24876,7 +24832,7 @@
             "application": {
                 "key": "common"
             },
-            "version": "0.8.92",
+            "version": "0.8.95",
             "enums": ["attribute_data_type", "availability_status", "calendar", "capability", "change_type", "currency_label_formatter", "currency_symbol_format", "day_of_week", "delivered_duty", "discount_target", "environment", "exception_type", "goods_supply", "holiday_calendar", "included_levy_key", "incoterm", "input_specification_type", "margin_type", "measurement_system", "merchant_of_record", "order_merchant_of_record", "price_book_status", "role", "rounding_method", "rounding_type", "schedule_exception_status", "sort_direction", "unit_of_measurement", "unit_of_time", "user_status", "value_added_service", "visibility"],
             "unions": ["discount_offer", "expandable_organization", "expandable_user", "input_specification_limitation", "price_source", "repeat_schedule"],
             "models": ["address", "billing_address", "catalog_item_reference", "catalog_item_summary", "checkout_reference", "contact", "customer_invoice", "customer_reference", "datetime_range", "dimension", "dimensions", "discount_form", "discount_offer_fixed", "discount_offer_percent", "discounts_form", "duration", "exception", "experience_summary", "included_levies", "input_form", "input_form_specification", "input_specification", "input_specification_limitation_max", "input_specification_limitations", "item_reference", "line_item", "line_item_form", "margin", "measurement", "merchant_of_record_entity", "merchant_of_record_entity_registration", "money", "money_with_base", "money_with_optional_base", "name", "order_customer", "order_customer_form", "organization", "organization_defaults", "organization_reference", "organization_summary", "partner_reference", "price", "price_form", "price_source_catalog", "price_source_price_book", "price_source_price_book_reference", "price_source_provided", "price_with_base", "repeat_daily", "repeat_hourly", "repeat_monthly", "repeat_weekly", "rounding", "schedule", "session_reference", "user", "user_reference", "zone"],
@@ -24890,7 +24846,7 @@
             "application": {
                 "key": "error"
             },
-            "version": "0.8.80",
+            "version": "0.8.95",
             "enums": ["generic_error_code"],
             "unions": [],
             "models": ["generic_error"],
@@ -24904,7 +24860,7 @@
             "application": {
                 "key": "permission"
             },
-            "version": "0.8.80",
+            "version": "0.8.95",
             "enums": ["authentication_technique", "flow_addon_role", "flow_behavior", "flow_user_role", "permitted_http_method"],
             "unions": ["flow_role"],
             "models": ["behavior_audit", "permission_audit", "permission_check", "permission_error", "permitted_route", "route_audit", "simple_permission_check"],
@@ -27270,7 +27226,7 @@
             "application": {
                 "key": "harmonization-internal"
             },
-            "version": "0.8.62",
+            "version": "0.8.65",
             "enums": ["empty_attribute", "item_classification_action", "item_classification_status", "item_type", "product_classification_action", "unclassified_product_status"],
             "unions": ["classification_label_attribute", "task_data"],
             "models": ["allowed_labels", "attribute_label", "blacklisted_item", "classification_item", "classification_product", "classification_product_id", "classification_product_summary", "classification_product_summary_page", "classified_product", "customs", "customs_description_statistics", "customs_description_suggestion", "customs_description_tariff_code_duty", "customs_description_tariff_code_duty_form", "duties", "harmonization_countries", "harmonization_statistics", "harmonization_statistics_breakout", "harmonization_summary", "item_harmonization", "item_harmonization_summary", "label_aliases", "label_association", "label_taxonomy", "levies", "levies_address", "levies_form", "levies_item", "product_classification", "product_classification_form", "product_classification_judgement_form", "product_classification_result", "product_harmonization", "product_harmonization_form", "product_labels", "search_item_hs6_code", "supported_labels", "tariff_code_duty", "task_import", "task_item_upserted", "task_process_queued_event", "task_summarize_code", "unclassified_products_form", "unphrased_products_export", "vies_result"],
@@ -27284,7 +27240,7 @@
             "application": {
                 "key": "price"
             },
-            "version": "0.8.80",
+            "version": "0.8.95",
             "enums": ["levy_component", "levy_strategy", "price_accuracy", "price_detail_component_key", "price_detail_key", "pricing_levy_setting"],
             "unions": ["deminimis"],
             "models": ["currency_format", "deminimis_per_item", "deminimis_simple", "duty", "local_price_details", "price_book", "price_book_form", "price_book_item", "price_book_item_form", "price_book_item_query_form", "price_book_item_schedule", "price_book_reference", "price_check", "price_detail", "price_detail_component", "price_details", "price_equation", "pricing", "tax"],
@@ -27298,7 +27254,7 @@
             "application": {
                 "key": "reference"
             },
-            "version": "0.8.80",
+            "version": "0.8.95",
             "enums": ["payment_method_type", "province_type"],
             "unions": [],
             "models": ["carrier", "carrier_service", "country", "currency", "currency_symbols", "language", "locale", "locale_numbers", "localized_translation", "payment_method", "payment_method_image", "payment_method_images", "province", "region", "timezone"],
@@ -32085,7 +32041,7 @@
                             "name": "status",
                             "location": "Query",
                             "type": "item_classification_status",
-                            "required": true
+                            "required": false
                         }, {
                             "name": "cursor",
                             "location": "Query",
@@ -52444,12 +52400,6 @@
                 }, {
                     "name": "unharmonized_items_export",
                     "attributes": []
-                }, {
-                    "name": "dutied_items_export",
-                    "attributes": []
-                }, {
-                    "name": "landed_cost_export",
-                    "attributes": []
                 }, {
                     "name": "harmonization_phrase_suggestion_request_import",
                     "attributes": []
@@ -52952,13 +52902,12 @@
         }, {
             "plural": "item_classification_statuses",
             "values": [{
-                    "name": "Unclassified",
-                    "attributes": []
-                }, {
-                    "name": "Suggested",
+                    "name": "ignored",
+                    "description": "some items/products like services can't be classified and have to be ignored.",
                     "attributes": []
                 }, {
-                    "name": "Classified",
+                    "name": "escalated",
+                    "description": "classification escalated to product/engineering team",
                     "attributes": []
                 }],
             "name": "item_classification_status",
@@ -53417,17 +53366,6 @@
             "name": "processor",
             "description": "Defines the available processors that we can use.",
             "attributes": []
-        }, {
-            "plural": "product_classification_actions",
-            "values": [{
-                    "name": "ACCEPT",
-                    "attributes": []
-                }, {
-                    "name": "MANUAL",
-                    "attributes": []
-                }],
-            "name": "product_classification_action",
-            "attributes": []
         }, {
             "plural": "prompt_actions",
             "values": [{
@@ -53802,17 +53740,6 @@
                 }],
             "name": "transfer_method",
             "attributes": []
-        }, {
-            "plural": "unclassified_product_statuses",
-            "values": [{
-                    "name": "ignored",
-                    "attributes": []
-                }, {
-                    "name": "escalated",
-                    "attributes": []
-                }],
-            "name": "unclassified_product_status",
-            "attributes": []
         }],
     "application": {
         "key": "api-internal"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowio/api-internal-mock-generator",
-  "version": "4.1.1",
+  "version": "4.1.3",
   "description": "A mock data generator based on our internal API specifications for JavaScript",
   "main": "dist/index.js",
   "scripts": {
@@ -34,5 +34,5 @@
     "tslint-config-airbnb": "^5.11.2",
     "typescript": "^3.6.3"
   },
-  "gitHead": "a0a371fb88d9267d5b1589694c9f13f42b83d985"
+  "gitHead": "30131101753d93459ca9ba8c259c95a06aa11698"
 }

package/src/api-internal.json

@@ -4986,7 +4986,7 @@
       "annotations" : [ ],
       "attributes" : [ ],
       "type" : "item_classification_status",
-      "required" : true
+      "required" : false
     }, {
       "default" : "[]",
       "name" : "customs_description_suggestions",
@@ -5098,7 +5098,7 @@
       "annotations" : [ ],
       "attributes" : [ ],
       "type" : "item_classification_status",
-      "required" : true
+      "required" : false
     }, {
       "name" : "suggestion_count",
       "annotations" : [ ],
@@ -11438,45 +11438,6 @@
       "type" : "map[decimal]",
       "required" : true
     } ]
-  }, {
-    "plural" : "landed_cost_exports",
-    "name" : "landed_cost_export",
-    "description" : "Export landed cost items.",
-    "attributes" : [ ],
-    "fields" : [ {
-      "name" : "event_id",
-      "annotations" : [ ],
-      "attributes" : [ ],
-      "type" : "string",
-      "required" : true
-    }, {
-      "name" : "timestamp",
-      "annotations" : [ ],
-      "description" : "The date/time of the request",
-      "attributes" : [ ],
-      "type" : "date-time-iso8601",
-      "required" : true
-    }, {
-      "name" : "organization",
-      "annotations" : [ ],
-      "description" : "Refers to your organization's account identifier",
-      "attributes" : [ ],
-      "type" : "string",
-      "required" : true
-    }, {
-      "name" : "export_id",
-      "annotations" : [ ],
-      "attributes" : [ ],
-      "type" : "string",
-      "required" : true
-    }, {
-      "name" : "items",
-      "annotations" : [ ],
-      "description" : "The list of item numbers to include in the export",
-      "attributes" : [ ],
-      "type" : "[landed_cost_item]",
-      "required" : true
-    } ]
   }, {
     "plural" : "landed_cost_items",
     "name" : "landed_cost_item",
@@ -17358,12 +17319,14 @@
     }, {
       "name" : "current_customs_description",
       "annotations" : [ ],
+      "description" : "the previous customs description in case the product was previously classified",
       "attributes" : [ ],
       "type" : "string",
       "required" : false
     }, {
       "name" : "customs_description",
       "annotations" : [ ],
+      "description" : "the customs description just computed by the classification model, if any",
       "attributes" : [ ],
       "type" : "string",
       "required" : false
@@ -17392,6 +17355,13 @@
     "name" : "product_classification_form",
     "attributes" : [ ],
     "fields" : [ {
+      "name" : "initial_customs_description",
+      "annotations" : [ ],
+      "description" : "Custom Description that was sent upon page load (if present)",
+      "attributes" : [ ],
+      "type" : "string",
+      "required" : false
+    }, {
       "name" : "product_harmonization",
       "annotations" : [ ],
       "attributes" : [ ],
@@ -17403,12 +17373,6 @@
       "attributes" : [ ],
       "type" : "string",
       "required" : true
-    }, {
-      "name" : "action",
-      "annotations" : [ ],
-      "attributes" : [ ],
-      "type" : "product_classification_action",
-      "required" : true
     } ]
   }, {
     "plural" : "product_classification_judgement_forms",
@@ -22132,7 +22096,7 @@
       "name" : "status",
       "annotations" : [ ],
       "attributes" : [ ],
-      "type" : "unclassified_product_status",
+      "type" : "item_classification_status",
       "required" : false
     } ]
   }, {
@@ -22939,14 +22903,6 @@
       "discriminator_value" : "unharmonized_items_export",
       "attributes" : [ ],
       "type" : "unharmonized_items_export"
-    }, {
-      "discriminator_value" : "dutied_items_export",
-      "attributes" : [ ],
-      "type" : "dutied_items_export"
-    }, {
-      "discriminator_value" : "landed_cost_export",
-      "attributes" : [ ],
-      "type" : "landed_cost_export"
     }, {
       "discriminator_value" : "harmonization_phrase_suggestion_request_import",
       "attributes" : [ ],
@@ -24876,7 +24832,7 @@
     "application" : {
       "key" : "common"
     },
-    "version" : "0.8.92",
+    "version" : "0.8.95",
     "enums" : [ "attribute_data_type", "availability_status", "calendar", "capability", "change_type", "currency_label_formatter", "currency_symbol_format", "day_of_week", "delivered_duty", "discount_target", "environment", "exception_type", "goods_supply", "holiday_calendar", "included_levy_key", "incoterm", "input_specification_type", "margin_type", "measurement_system", "merchant_of_record", "order_merchant_of_record", "price_book_status", "role", "rounding_method", "rounding_type", "schedule_exception_status", "sort_direction", "unit_of_measurement", "unit_of_time", "user_status", "value_added_service", "visibility" ],
     "unions" : [ "discount_offer", "expandable_organization", "expandable_user", "input_specification_limitation", "price_source", "repeat_schedule" ],
     "models" : [ "address", "billing_address", "catalog_item_reference", "catalog_item_summary", "checkout_reference", "contact", "customer_invoice", "customer_reference", "datetime_range", "dimension", "dimensions", "discount_form", "discount_offer_fixed", "discount_offer_percent", "discounts_form", "duration", "exception", "experience_summary", "included_levies", "input_form", "input_form_specification", "input_specification", "input_specification_limitation_max", "input_specification_limitations", "item_reference", "line_item", "line_item_form", "margin", "measurement", "merchant_of_record_entity", "merchant_of_record_entity_registration", "money", "money_with_base", "money_with_optional_base", "name", "order_customer", "order_customer_form", "organization", "organization_defaults", "organization_reference", "organization_summary", "partner_reference", "price", "price_form", "price_source_catalog", "price_source_price_book", "price_source_price_book_reference", "price_source_provided", "price_with_base", "repeat_daily", "repeat_hourly", "repeat_monthly", "repeat_weekly", "rounding", "schedule", "session_reference", "user", "user_reference", "zone" ],
@@ -24890,7 +24846,7 @@
     "application" : {
       "key" : "error"
     },
-    "version" : "0.8.80",
+    "version" : "0.8.95",
     "enums" : [ "generic_error_code" ],
     "unions" : [ ],
     "models" : [ "generic_error" ],
@@ -24904,7 +24860,7 @@
     "application" : {
       "key" : "permission"
     },
-    "version" : "0.8.80",
+    "version" : "0.8.95",
     "enums" : [ "authentication_technique", "flow_addon_role", "flow_behavior", "flow_user_role", "permitted_http_method" ],
     "unions" : [ "flow_role" ],
     "models" : [ "behavior_audit", "permission_audit", "permission_check", "permission_error", "permitted_route", "route_audit", "simple_permission_check" ],
@@ -27270,7 +27226,7 @@
     "application" : {
       "key" : "harmonization-internal"
     },
-    "version" : "0.8.62",
+    "version" : "0.8.65",
     "enums" : [ "empty_attribute", "item_classification_action", "item_classification_status", "item_type", "product_classification_action", "unclassified_product_status" ],
     "unions" : [ "classification_label_attribute", "task_data" ],
     "models" : [ "allowed_labels", "attribute_label", "blacklisted_item", "classification_item", "classification_product", "classification_product_id", "classification_product_summary", "classification_product_summary_page", "classified_product", "customs", "customs_description_statistics", "customs_description_suggestion", "customs_description_tariff_code_duty", "customs_description_tariff_code_duty_form", "duties", "harmonization_countries", "harmonization_statistics", "harmonization_statistics_breakout", "harmonization_summary", "item_harmonization", "item_harmonization_summary", "label_aliases", "label_association", "label_taxonomy", "levies", "levies_address", "levies_form", "levies_item", "product_classification", "product_classification_form", "product_classification_judgement_form", "product_classification_result", "product_harmonization", "product_harmonization_form", "product_labels", "search_item_hs6_code", "supported_labels", "tariff_code_duty", "task_import", "task_item_upserted", "task_process_queued_event", "task_summarize_code", "unclassified_products_form", "unphrased_products_export", "vies_result" ],
@@ -27284,7 +27240,7 @@
     "application" : {
       "key" : "price"
     },
-    "version" : "0.8.80",
+    "version" : "0.8.95",
     "enums" : [ "levy_component", "levy_strategy", "price_accuracy", "price_detail_component_key", "price_detail_key", "pricing_levy_setting" ],
     "unions" : [ "deminimis" ],
     "models" : [ "currency_format", "deminimis_per_item", "deminimis_simple", "duty", "local_price_details", "price_book", "price_book_form", "price_book_item", "price_book_item_form", "price_book_item_query_form", "price_book_item_schedule", "price_book_reference", "price_check", "price_detail", "price_detail_component", "price_details", "price_equation", "pricing", "tax" ],
@@ -27298,7 +27254,7 @@
     "application" : {
       "key" : "reference"
     },
-    "version" : "0.8.80",
+    "version" : "0.8.95",
     "enums" : [ "payment_method_type", "province_type" ],
     "unions" : [ ],
     "models" : [ "carrier", "carrier_service", "country", "currency", "currency_symbols", "language", "locale", "locale_numbers", "localized_translation", "payment_method", "payment_method_image", "payment_method_images", "province", "region", "timezone" ],
@@ -32085,7 +32041,7 @@
         "name" : "status",
         "location" : "Query",
         "type" : "item_classification_status",
-        "required" : true
+        "required" : false
       }, {
         "name" : "cursor",
         "location" : "Query",
@@ -52444,12 +52400,6 @@
     }, {
       "name" : "unharmonized_items_export",
       "attributes" : [ ]
-    }, {
-      "name" : "dutied_items_export",
-      "attributes" : [ ]
-    }, {
-      "name" : "landed_cost_export",
-      "attributes" : [ ]
     }, {
       "name" : "harmonization_phrase_suggestion_request_import",
       "attributes" : [ ]
@@ -52952,13 +52902,12 @@
   }, {
     "plural" : "item_classification_statuses",
     "values" : [ {
-      "name" : "Unclassified",
-      "attributes" : [ ]
-    }, {
-      "name" : "Suggested",
+      "name" : "ignored",
+      "description" : "some items/products like services can't be classified and have to be ignored.",
       "attributes" : [ ]
     }, {
-      "name" : "Classified",
+      "name" : "escalated",
+      "description" : "classification escalated to product/engineering team",
       "attributes" : [ ]
     } ],
     "name" : "item_classification_status",
@@ -53417,17 +53366,6 @@
     "name" : "processor",
     "description" : "Defines the available processors that we can use.",
     "attributes" : [ ]
-  }, {
-    "plural" : "product_classification_actions",
-    "values" : [ {
-      "name" : "ACCEPT",
-      "attributes" : [ ]
-    }, {
-      "name" : "MANUAL",
-      "attributes" : [ ]
-    } ],
-    "name" : "product_classification_action",
-    "attributes" : [ ]
   }, {
     "plural" : "prompt_actions",
     "values" : [ {
@@ -53802,17 +53740,6 @@
     } ],
     "name" : "transfer_method",
     "attributes" : [ ]
-  }, {
-    "plural" : "unclassified_product_statuses",
-    "values" : [ {
-      "name" : "ignored",
-      "attributes" : [ ]
-    }, {
-      "name" : "escalated",
-      "attributes" : [ ]
-    } ],
-    "name" : "unclassified_product_status",
-    "attributes" : [ ]
   } ],
   "application" : {
     "key" : "api-internal"