@flowio/api-internal-mock-generator 5.31.29 → 5.31.30

package/dist/api-internal.json

@@ -5309,6 +5309,14 @@
                 }],
             "attributes": [],
             "description": "Defines the valid discriminators for tariff_eligibility to enforce in the resource path"
+        }, {
+            "name": "task_processor_key",
+            "plural": "task_processor_keys",
+            "values": [{
+                    "name": "billing_account",
+                    "attributes": []
+                }],
+            "attributes": []
         }, {
             "name": "tax_calculation_error_code",
             "plural": "tax_calculation_error_codes",
@@ -43548,7 +43556,7 @@
                     "required": false,
                     "attributes": [],
                     "annotations": [],
-                    "description": "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `FlowComm*` to form the final statement. E.g. `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, spaces, and `.,-_+/?&`"
+                    "description": "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `Global-e/` (for merchants that are part of the Shopify channels) or `FlowComm*` (for merchants that integrated with Flow directly) to form the final statement. E.g. `Global-e/ClientName` or `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, spaces, and `.,-_+/?&`"
                 }, {
                     "name": "payment_statement_condensed",
                     "type": "string",
@@ -43613,7 +43621,7 @@
                     "required": false,
                     "attributes": [],
                     "annotations": [],
-                    "description": "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `FlowComm*` to form the final statement. E.g. `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, spaces, and `.,-_+/?&`",
+                    "description": "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `Global-e/` (for merchants that are part of the Shopify channels) or `FlowComm*` (for merchants that integrated with Flow directly) to form the final statement. E.g. `Global-e/ClientName` or `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, spaces, and `.,-_+/?&`",
                     "example": "ClientName"
                 }],
             "attributes": [],
@@ -44188,7 +44196,7 @@
                     "required": false,
                     "attributes": [],
                     "annotations": [],
-                    "description": "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `FlowComm*` to form the final statement. E.g. `FlowComm*ClientName`."
+                    "description": "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `Global-e/` (for merchants that are part of the Shopify channels) or `FlowComm*` (for merchants that integrated with Flow directly) to form the final statement. E.g. `Global-e/ClientName` or `FlowComm*ClientName`."
                 }, {
                     "name": "payment_statement_condensed",
                     "type": "string",
@@ -44243,7 +44251,7 @@
                     "required": false,
                     "attributes": [],
                     "annotations": [],
-                    "description": "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `FlowComm*` to form the final statement. E.g. `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, ` .,-_+/?&`"
+                    "description": "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `Global-e/` (for merchants that are part of the Shopify channels) or `FlowComm*` (for merchants that integrated with Flow directly) to form the final statement. E.g. `Global-e/ClientName` or `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, ` .,-_+/?&`"
                 }],
             "attributes": [],
             "interfaces": [],
@@ -48170,6 +48178,43 @@
             "attributes": [],
             "interfaces": [],
             "description": "for category list on dashboard"
+        }, {
+            "name": "restriction_filter",
+            "plural": "restriction_filters",
+            "fields": [{
+                    "name": "categories",
+                    "type": "[string]",
+                    "required": true,
+                    "attributes": [],
+                    "annotations": []
+                }, {
+                    "name": "users",
+                    "type": "[io.flow.common.v0.models.user]",
+                    "required": true,
+                    "attributes": [],
+                    "annotations": []
+                }, {
+                    "name": "rules",
+                    "type": "[restriction_rule_summary]",
+                    "required": true,
+                    "attributes": [],
+                    "annotations": []
+                }, {
+                    "name": "positive_keywords",
+                    "type": "[string]",
+                    "required": true,
+                    "attributes": [],
+                    "annotations": []
+                }, {
+                    "name": "negative_keywords",
+                    "type": "[string]",
+                    "required": true,
+                    "attributes": [],
+                    "annotations": []
+                }],
+            "attributes": [],
+            "interfaces": [],
+            "description": "all valid filters, including categories and keywords given a organization and all restrictions regardless of organization"
         }, {
             "name": "restriction_history_item_review_decision",
             "plural": "restriction_history_item_review_decisions",
@@ -67548,51 +67593,6 @@
             "type": "io.flow.common.v0.models.user",
             "plural": "users",
             "operations": [{
-                    "method": "GET",
-                    "path": "/jailhouse/restriction/:organization/users",
-                    "parameters": [{
-                            "name": "organization",
-                            "type": "string",
-                            "location": "Path",
-                            "required": true,
-                            "description": "Refers to your organization's account identifier"
-                        }],
-                    "responses": [{
-                            "code": {
-                                "integer": {
-                                    "value": 200
-                                }
-                            },
-                            "type": "[io.flow.common.v0.models.user]",
-                            "description": "Successful response",
-                            "attributes": []
-                        }, {
-                            "code": {
-                                "integer": {
-                                    "value": 401
-                                }
-                            },
-                            "type": "unit",
-                            "description": "Authorization failed",
-                            "attributes": []
-                        }, {
-                            "code": {
-                                "integer": {
-                                    "value": 422
-                                }
-                            },
-                            "type": "io.flow.error.v0.models.generic_error",
-                            "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
-                            "attributes": []
-                        }],
-                    "attributes": [{
-                            "name": "linter",
-                            "value": {
-                                "ignore": ["get", "id", "limit", "offset", "sort"]
-                            }
-                        }],
-                    "description": "Returns list all of the users who have taken any action on products for an organization"
-                }, {
                     "method": "GET",
                     "path": "/internal/users/pending",
                     "parameters": [],
@@ -67682,7 +67682,7 @@
                         "module": "general"
                     }
                 }],
-            "path": "/jailhouse/restriction/:organization/users",
+            "path": "/internal/users",
             "description": "Represents a single user in the system"
         }, {
             "type": "io.flow.crypto.v0.models.crypto_event",
@@ -82908,6 +82908,80 @@
                 }],
             "path": "/jailhouse/restriction/:organization/categories",
             "description": "for category list on dashboard"
+        }, {
+            "type": "restriction_filter",
+            "plural": "restriction_filters",
+            "operations": [{
+                    "method": "GET",
+                    "path": "/jailhouse/restriction/:organization/filters",
+                    "parameters": [{
+                            "name": "organization",
+                            "type": "string",
+                            "location": "Path",
+                            "required": true,
+                            "description": "Refers to your organization's account identifier"
+                        }, {
+                            "name": "limit",
+                            "type": "long",
+                            "location": "Query",
+                            "required": true,
+                            "description": "The maximum number of results to return",
+                            "default": "25",
+                            "minimum": 1,
+                            "maximum": 100
+                        }, {
+                            "name": "offset",
+                            "type": "long",
+                            "location": "Query",
+                            "required": true,
+                            "description": "The number of results to skip before returning results",
+                            "default": "0",
+                            "minimum": 0
+                        }],
+                    "responses": [{
+                            "code": {
+                                "integer": {
+                                    "value": 200
+                                }
+                            },
+                            "type": "restriction_filter",
+                            "description": "Successful response",
+                            "attributes": []
+                        }, {
+                            "code": {
+                                "integer": {
+                                    "value": 401
+                                }
+                            },
+                            "type": "unit",
+                            "description": "Authorization failed",
+                            "attributes": []
+                        }, {
+                            "code": {
+                                "integer": {
+                                    "value": 422
+                                }
+                            },
+                            "type": "io.flow.error.v0.models.generic_error",
+                            "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
+                            "attributes": []
+                        }],
+                    "attributes": [{
+                            "name": "linter",
+                            "value": {
+                                "ignore": ["get", "id", "sort"]
+                            }
+                        }],
+                    "description": "Returns all valid filters (categories, keywords) for an given organization and all restrictions in system"
+                }],
+            "attributes": [{
+                    "name": "docs",
+                    "value": {
+                        "module": "general"
+                    }
+                }],
+            "path": "/jailhouse/restriction/:organization/filters",
+            "description": "all valid filters, including categories and keywords given a organization and all restrictions regardless of organization"
         }, {
             "type": "restriction_item",
             "plural": "restriction_items",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowio/api-internal-mock-generator",
-  "version": "5.31.29",
+  "version": "5.31.30",
   "description": "A mock data generator based on our internal API specifications for JavaScript",
   "keywords": [
     "flowcommerce",
@@ -29,5 +29,5 @@
     "apibuilder-js": "0.0.13",
     "apibuilder-mock-generator": "0.0.13"
   },
-  "gitHead": "d8694eb84532d183fb8f7a810039f90bb74ee7ec"
+  "gitHead": "86f7a2871f7d3b7b28a1e7e7d0388487b8d96c06"
 }

package/src/api-internal.json

@@ -5309,6 +5309,14 @@
     } ],
     "attributes" : [ ],
     "description" : "Defines the valid discriminators for tariff_eligibility to enforce in the resource path"
+  }, {
+    "name" : "task_processor_key",
+    "plural" : "task_processor_keys",
+    "values" : [ {
+      "name" : "billing_account",
+      "attributes" : [ ]
+    } ],
+    "attributes" : [ ]
   }, {
     "name" : "tax_calculation_error_code",
     "plural" : "tax_calculation_error_codes",
@@ -43548,7 +43556,7 @@
       "required" : false,
       "attributes" : [ ],
       "annotations" : [ ],
-      "description" : "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `FlowComm*` to form the final statement. E.g. `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, spaces, and `.,-_+/?&`"
+      "description" : "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `Global-e/` (for merchants that are part of the Shopify channels) or `FlowComm*` (for merchants that integrated with Flow directly) to form the final statement. E.g. `Global-e/ClientName` or `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, spaces, and `.,-_+/?&`"
     }, {
       "name" : "payment_statement_condensed",
       "type" : "string",
@@ -43613,7 +43621,7 @@
       "required" : false,
       "attributes" : [ ],
       "annotations" : [ ],
-      "description" : "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `FlowComm*` to form the final statement. E.g. `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, spaces, and `.,-_+/?&`",
+      "description" : "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `Global-e/` (for merchants that are part of the Shopify channels) or `FlowComm*` (for merchants that integrated with Flow directly) to form the final statement. E.g. `Global-e/ClientName` or `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, spaces, and `.,-_+/?&`",
       "example" : "ClientName"
     } ],
     "attributes" : [ ],
@@ -44188,7 +44196,7 @@
       "required" : false,
       "attributes" : [ ],
       "annotations" : [ ],
-      "description" : "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `FlowComm*` to form the final statement. E.g. `FlowComm*ClientName`."
+      "description" : "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `Global-e/` (for merchants that are part of the Shopify channels) or `FlowComm*` (for merchants that integrated with Flow directly) to form the final statement. E.g. `Global-e/ClientName` or `FlowComm*ClientName`."
     }, {
       "name" : "payment_statement_condensed",
       "type" : "string",
@@ -44243,7 +44251,7 @@
       "required" : false,
       "attributes" : [ ],
       "annotations" : [ ],
-      "description" : "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `FlowComm*` to form the final statement. E.g. `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, ` .,-_+/?&`"
+      "description" : "The transaction description that appears on bank / credit card statements. When Flow is MoR, it will be prepended with `Global-e/` (for merchants that are part of the Shopify channels) or `FlowComm*` (for merchants that integrated with Flow directly) to form the final statement. E.g. `Global-e/ClientName` or `FlowComm*ClientName`. Most special characters are not allowed and suffixes over 13 characters may be truncated for credit card statements. Allowed characters: roman letters, numbers, ` .,-_+/?&`"
     } ],
     "attributes" : [ ],
     "interfaces" : [ ],
@@ -48170,6 +48178,43 @@
     "attributes" : [ ],
     "interfaces" : [ ],
     "description" : "for category list on dashboard"
+  }, {
+    "name" : "restriction_filter",
+    "plural" : "restriction_filters",
+    "fields" : [ {
+      "name" : "categories",
+      "type" : "[string]",
+      "required" : true,
+      "attributes" : [ ],
+      "annotations" : [ ]
+    }, {
+      "name" : "users",
+      "type" : "[io.flow.common.v0.models.user]",
+      "required" : true,
+      "attributes" : [ ],
+      "annotations" : [ ]
+    }, {
+      "name" : "rules",
+      "type" : "[restriction_rule_summary]",
+      "required" : true,
+      "attributes" : [ ],
+      "annotations" : [ ]
+    }, {
+      "name" : "positive_keywords",
+      "type" : "[string]",
+      "required" : true,
+      "attributes" : [ ],
+      "annotations" : [ ]
+    }, {
+      "name" : "negative_keywords",
+      "type" : "[string]",
+      "required" : true,
+      "attributes" : [ ],
+      "annotations" : [ ]
+    } ],
+    "attributes" : [ ],
+    "interfaces" : [ ],
+    "description" : "all valid filters, including categories and keywords given a organization and all restrictions regardless of organization"
   }, {
     "name" : "restriction_history_item_review_decision",
     "plural" : "restriction_history_item_review_decisions",
@@ -67548,51 +67593,6 @@
     "type" : "io.flow.common.v0.models.user",
     "plural" : "users",
     "operations" : [ {
-      "method" : "GET",
-      "path" : "/jailhouse/restriction/:organization/users",
-      "parameters" : [ {
-        "name" : "organization",
-        "type" : "string",
-        "location" : "Path",
-        "required" : true,
-        "description" : "Refers to your organization's account identifier"
-      } ],
-      "responses" : [ {
-        "code" : {
-          "integer" : {
-            "value" : 200
-          }
-        },
-        "type" : "[io.flow.common.v0.models.user]",
-        "description" : "Successful response",
-        "attributes" : [ ]
-      }, {
-        "code" : {
-          "integer" : {
-            "value" : 401
-          }
-        },
-        "type" : "unit",
-        "description" : "Authorization failed",
-        "attributes" : [ ]
-      }, {
-        "code" : {
-          "integer" : {
-            "value" : 422
-          }
-        },
-        "type" : "io.flow.error.v0.models.generic_error",
-        "description" : "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
-        "attributes" : [ ]
-      } ],
-      "attributes" : [ {
-        "name" : "linter",
-        "value" : {
-          "ignore" : [ "get", "id", "limit", "offset", "sort" ]
-        }
-      } ],
-      "description" : "Returns list all of the users who have taken any action on products for an organization"
-    }, {
       "method" : "GET",
       "path" : "/internal/users/pending",
       "parameters" : [ ],
@@ -67682,7 +67682,7 @@
         "module" : "general"
       }
     } ],
-    "path" : "/jailhouse/restriction/:organization/users",
+    "path" : "/internal/users",
     "description" : "Represents a single user in the system"
   }, {
     "type" : "io.flow.crypto.v0.models.crypto_event",
@@ -82908,6 +82908,80 @@
     } ],
     "path" : "/jailhouse/restriction/:organization/categories",
     "description" : "for category list on dashboard"
+  }, {
+    "type" : "restriction_filter",
+    "plural" : "restriction_filters",
+    "operations" : [ {
+      "method" : "GET",
+      "path" : "/jailhouse/restriction/:organization/filters",
+      "parameters" : [ {
+        "name" : "organization",
+        "type" : "string",
+        "location" : "Path",
+        "required" : true,
+        "description" : "Refers to your organization's account identifier"
+      }, {
+        "name" : "limit",
+        "type" : "long",
+        "location" : "Query",
+        "required" : true,
+        "description" : "The maximum number of results to return",
+        "default" : "25",
+        "minimum" : 1,
+        "maximum" : 100
+      }, {
+        "name" : "offset",
+        "type" : "long",
+        "location" : "Query",
+        "required" : true,
+        "description" : "The number of results to skip before returning results",
+        "default" : "0",
+        "minimum" : 0
+      } ],
+      "responses" : [ {
+        "code" : {
+          "integer" : {
+            "value" : 200
+          }
+        },
+        "type" : "restriction_filter",
+        "description" : "Successful response",
+        "attributes" : [ ]
+      }, {
+        "code" : {
+          "integer" : {
+            "value" : 401
+          }
+        },
+        "type" : "unit",
+        "description" : "Authorization failed",
+        "attributes" : [ ]
+      }, {
+        "code" : {
+          "integer" : {
+            "value" : 422
+          }
+        },
+        "type" : "io.flow.error.v0.models.generic_error",
+        "description" : "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
+        "attributes" : [ ]
+      } ],
+      "attributes" : [ {
+        "name" : "linter",
+        "value" : {
+          "ignore" : [ "get", "id", "sort" ]
+        }
+      } ],
+      "description" : "Returns all valid filters (categories, keywords) for an given organization and all restrictions in system"
+    } ],
+    "attributes" : [ {
+      "name" : "docs",
+      "value" : {
+        "module" : "general"
+      }
+    } ],
+    "path" : "/jailhouse/restriction/:organization/filters",
+    "description" : "all valid filters, including categories and keywords given a organization and all restrictions regardless of organization"
   }, {
     "type" : "restriction_item",
     "plural" : "restriction_items",