Merge pull request #8 from wrtnio/feat/payment

Payment plugin properties again
wrtnlabs · Nov 20, 2024 · 136a51b · 136a51b
2 parents 30a0da8 + fb98e1c
commit 136a51b
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 9 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@wrtnio/schema",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "JSON and LLM function calling schemas extended for Wrtn Studio Pro",
   "main": "lib/index.js",
   "module": "./lib/index.mjs",

diff --git a/src/ISwaggerSchemaPaymentPlugin.ts b/src/ISwaggerSchemaPaymentPlugin.ts
@@ -24,6 +24,18 @@ export namespace ISwaggerSchemaPaymentPlugin {
      */
     "x-wrtn-payment-order-id"?: true;
 
+    /**
+     * The citizen ID who've ordered the payment.
+     *
+     * If an order appliance function be called and it returns a value with
+     * `x-wrtn-payment-citizen-id` property, the value means the citizen
+     * ID who've ordered the payment.
+     *
+     * When processing the publish, you have to fill the next payment
+     * function's parameter with the citizen ID who've ordered the payment.
+     */
+    "x-wrtn-payment-citizen-id"?: true;
+
     /**
      * The amount of the payment should be paid.
      *
@@ -116,34 +128,46 @@ export namespace ISwaggerSchemaPaymentPlugin {
      * function's parameter with the target order's name.
      *
      * Note that, this `x-wrtn-payment-order-name` is different with the
-     * {@link IVendor.x-wrtn-payment-order-citizen}. This is not the name
+     * {@link IVendor.x-wrtn-payment-citizen-name}. This is not the name
      * or citizen, but of the target order.
      */
     "x-wrtn-payment-order-name"?: true;
 
     /**
-     * The citizen who've ordered the payment.
+     * The citizen ID who've ordered the payment.
      *
      * If an order appliance function be called and it returns a value with
-     * `x-wrtn-payment-order-citizen` property, the value means the citizen
-     * who've ordered the payment.
+     * `x-wrtn-payment-citizen-id` property, the value means the citizen
+     * ID who've ordered the payment.
+     *
+     * When processing the publish, you have to fill the next payment
+     * function's parameter with the citizen ID who've ordered the payment.
+     */
+    "x-wrtn-payment-citizen-id"?: true;
+
+    /**
+     * The citizen name who've ordered the payment.
+     *
+     * If an order appliance function be called and it returns a value with
+     * `x-wrtn-payment-citizen-name` property, the value means the citizen
+     * name who've ordered the payment.
      *
      * When processing the publish, you have to fill the next payment
-     * function's parameter with the citizen who've ordered the payment.
+     * function's parameter with the citizen name who've ordered the payment.
      */
-    "x-wrtn-payment-order-citizen"?: true;
+    "x-wrtn-payment-citizen-name"?: true;
 
     /**
      * The mobile phone number of the citizen who've ordered the payment.
      *
      * If an order appliance function be called and it returns a value with
-     * `x-wrtn-payment-order-mobile` property, the value means the mobile
+     * `x-wrtn-payment-citizen-mobile` property, the value means the mobile
      * phone number of the citizen who've ordered the payment.
      *
      * When processing the publish, you have to fill the next payment
      * function's parameter with the mobile phone number of the citizen
      * who've ordered the payment.
      */
-    "x-wrtn-payment-order-mobile"?: true;
+    "x-wrtn-payment-citizen-mobile"?: true;
   }
 }