summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorpriscilla <priscilla.huang@efrei.net>2022-11-15 07:36:05 -0500
committerpriscilla <priscilla.huang@efrei.net>2022-11-15 07:36:05 -0500
commit2bc71736a538297ffe5cabf2ea298bf7aa9f1a60 (patch)
tree6966c94bb159fbdb09a8def1ca96bb9d572cf4ec /core
parent51d2eec1ead9ee198eee6bceaed11e6f70ba8afa (diff)
downloaddocs-2bc71736a538297ffe5cabf2ea298bf7aa9f1a60.tar.gz
docs-2bc71736a538297ffe5cabf2ea298bf7aa9f1a60.tar.bz2
docs-2bc71736a538297ffe5cabf2ea298bf7aa9f1a60.zip
Update
Diffstat (limited to 'core')
-rw-r--r--core/api-merchant.rst43
1 files changed, 23 insertions, 20 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 1d0bb528..b29739bd 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -3069,15 +3069,15 @@ Adding templates
The merchant instance is unknown or it is not in our data.
- .. ts:def:: TemplateAddDetail
+ .. ts:def:: TemplateAddDetails
- interface TemplateAddDetail {
+ interface TemplateAddDetails {
// Template ID to use.
template_id: string;
// Human-readable description for the template.
- template_descripton: string;
+ template_description: string;
// A base64-encoded image selected by the merchant.
// This parameter is optional.
@@ -3085,19 +3085,19 @@ Adding templates
image?: ImageDataUrl;
// Additional information in a separate template.
- template_detail: TemplateSeparateDetail[];
+ template_contract: TemplateContractDetails;
}
- .. ts:def:: TemplateSeparateDetail
+ .. ts:def:: TemplateContractDetails
- interface TemplateSeparateDetail {
+ interface TemplateContractDetails {
// Human-readable summary for the template.
- summary: string;
+ summary?: string;
// The price is imposed by the merchant and cannot be changed by the customer.
- // This parametrer is optional.
+ // This parameter is optional.
amount?: Amount;
// Minimum age buyer must have (in years). Default is 0.
@@ -3112,7 +3112,7 @@ Editing templates
.. http:patch:: [/instances/$INSTANCE]/private/templates/$TEMPLATE_ID
- This is used to update template.
+ This is used to update a template.
**Request:**
@@ -3121,7 +3121,7 @@ Editing templates
**Response:**
:http:statuscode:`204 No content`:
- The templates has successfully modififed.
+ The templates has successfully modified.
:http:statuscode:`404 Not found`:
The templates(ID) is unknown to the backend.
:http:statuscode:`409 Conflict`:
@@ -3129,12 +3129,12 @@ Editing templates
another store.
- .. ts:def:: TemplatePatchDetail
+ .. ts:def:: TemplatePatchDetails
- interface TemplatePatchDetail {
+ interface TemplatePatchDetails {
// Human-readable description for the template.
- template_descripton: string;
+ template_description: string;
// A base64-encoded image selected by the merchant.
// This parameter is optional.
@@ -3142,9 +3142,9 @@ Editing templates
image?: ImageDataUrl;
// Additional information in a separate template.
- template_detail: TemplateSeparateDetail[];
+ template_contract: TemplateContractDetails;
- }
+ }
@@ -3170,7 +3170,7 @@ Inspecting template
// List of templates that are present in our backend.
templates_list: TemplateEntry[];
- }
+ }
@@ -3185,7 +3185,10 @@ The `TemplatesEntry` object describes a template. It has the following structure
// Template identifier, as found in the template.
template_id: string;
- }
+ // Human-readable description for the template.
+ template_description: string;
+
+ }
@@ -3208,7 +3211,7 @@ The `TemplatesEntry` object describes a template. It has the following structure
interface TemplateDetail {
// Human-readable description for the template.
- template_descripton: string;
+ template_description: string;
// A base64-encoded image selected by the merchant.
// This parameter is optional.
@@ -3216,8 +3219,8 @@ The `TemplatesEntry` object describes a template. It has the following structure
image?: ImageDataUrl;
// Additional information in a separate template.
- template_detail: TemplateSeparateDetail[];
- }
+ template_contract: TemplateContractDetails;
+ }