JSON Schema Update

Author: nobody

_data/v3.yml

@@ -35,6 +35,8 @@ groups:
         title: Cancel a Contract
       - name: cashier
         title: Cashier Information
+      - name: confirm_email
+        title: Confirm Email Through Verification Code
       - name: contract_update
         title: Update Contract
       - name: contract_update_history

config/v3/confirm_email/example.json

@@ -0,0 +1,5 @@
+{
+    "confirm_email": 1,
+    "email_consent": 1,
+    "verification_code": "ExampleVerificationCode"
+}

config/v3/confirm_email/receive.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Confirm Email Through Verification Code (response)",
+    "description": "Confirm Email Response",
+    "type": "object",
+    "required": [
+        "echo_req",
+        "msg_type"
+    ],
+    "properties": {
+        "confirm_email": {
+            "title": "confirm_email",
+            "description": "1 for success (The verification code has been successfully verified)",
+            "type": "integer",
+            "enum": [
+                0,
+                1
+            ]
+        },
+        "echo_req": {
+            "description": "Echo of the request made.",
+            "type": "object"
+        },
+        "msg_type": {
+            "description": "Action name of the request made.",
+            "type": "string",
+            "enum": [
+                "confirm_email"
+            ]
+        },
+        "req_id": {
+            "description": "Optional field sent in request to map to response, present only when request contains `req_id`.",
+            "type": "integer"
+        }
+    }
+}

config/v3/confirm_email/send.json

@@ -0,0 +1,44 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Confirm Email Through Verification Code (request)",
+    "description": "Verifies the email for the user using verification code passed in the request object",
+    "type": "object",
+    "auth_required": 0,
+    "additionalProperties": false,
+    "required": [
+        "confirm_email",
+        "email_consent",
+        "verification_code"
+    ],
+    "properties": {
+        "confirm_email": {
+            "description": "Must be `1`",
+            "type": "integer",
+            "enum": [
+                1
+            ]
+        },
+        "email_consent": {
+            "description": "Boolean value: 1 or 0, indicating whether the client has given consent for marketing emails.",
+            "type": "integer",
+            "enum": [
+                1,
+                0
+            ]
+        },
+        "verification_code": {
+            "description": "Email verification code (received from a `verify_email` call, which must be done first).",
+            "type": "string",
+            "pattern": "^\\w{8,128}$",
+            "sensitive": 1
+        },
+        "passthrough": {
+            "description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field.",
+            "type": "object"
+        },
+        "req_id": {
+            "description": "[Optional] Used to map request to response.",
+            "type": "integer"
+        }
+    }
+}