Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Payment plugin properties again #8

Merged
merged 1 commit into from
Nov 20, 2024
+33 −9
Merged

Payment plugin properties again #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
40 changes: 32 additions & 8 deletions src/ISwaggerSchemaPaymentPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down Expand Up @@ -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;
}
}