@ratio-mcp/docs-server 1.5.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +75 -0
- package/dist/schemas/app-distribution.json +36 -0
- package/dist/schemas/customers.json +26 -0
- package/dist/schemas/discounts.json +81 -0
- package/dist/schemas/draft_orders.json +112 -0
- package/dist/schemas/loyalty.json +147 -0
- package/dist/schemas/orders.json +597 -102
- package/dist/schemas/product_reviews.json +45 -0
- package/dist/schemas/products.json +401 -118
- package/dist/schemas/tags.json +98 -0
- package/dist/schemas/variants.json +112 -0
- package/dist/schemas/webhooks.json +94 -15
- package/dist/tools/get-api-reference.d.ts.map +1 -1
- package/dist/tools/get-api-reference.js +4 -1
- package/dist/tools/get-api-reference.js.map +1 -1
- package/dist/tools/get-scope-map.d.ts.map +1 -1
- package/dist/tools/get-scope-map.js +7 -1
- package/dist/tools/get-scope-map.js.map +1 -1
- package/dist/tools/get-scopes.d.ts +3 -0
- package/dist/tools/get-scopes.d.ts.map +1 -1
- package/dist/tools/get-scopes.js +13 -2
- package/dist/tools/get-scopes.js.map +1 -1
- package/dist/tools/lookup-docs.d.ts +1 -1
- package/dist/tools/lookup-docs.d.ts.map +1 -1
- package/dist/tools/lookup-docs.js +27 -4
- package/dist/tools/lookup-docs.js.map +1 -1
- package/dist/tools/validate-code.d.ts.map +1 -1
- package/dist/tools/validate-code.js +0 -4
- package/dist/tools/validate-code.js.map +1 -1
- package/dist/utils/schema-loader.d.ts +5 -1
- package/dist/utils/schema-loader.d.ts.map +1 -1
- package/dist/utils/schema-loader.js +8 -2
- package/dist/utils/schema-loader.js.map +1 -1
- package/package.json +3 -3
- package/dist/schemas/schemas/oauth.json +0 -71
- package/dist/schemas/schemas/orders.json +0 -167
- package/dist/schemas/schemas/products.json +0 -167
- package/dist/schemas/schemas/scopes.json +0 -52
- package/dist/schemas/schemas/webhooks.json +0 -69
- package/dist/schemas/scopes.json +0 -52
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 1,
|
|
3
|
-
"resources": {
|
|
4
|
-
"orders": {
|
|
5
|
-
"display_name": "Orders",
|
|
6
|
-
"description": "Access and manage merchant orders",
|
|
7
|
-
"scopes": {
|
|
8
|
-
"read_orders": {
|
|
9
|
-
"label": "Read Orders",
|
|
10
|
-
"description": "View orders and order details",
|
|
11
|
-
"access": "read-only",
|
|
12
|
-
"endpoints": ["GET /api/v1/orders", "GET /api/v1/orders/:id"]
|
|
13
|
-
},
|
|
14
|
-
"order-create": {
|
|
15
|
-
"label": "Order Create/Update",
|
|
16
|
-
"description": "Create, update, and cancel orders",
|
|
17
|
-
"access": "read-write",
|
|
18
|
-
"inherits": "read_orders",
|
|
19
|
-
"endpoints": [
|
|
20
|
-
"POST /api/v1/orders",
|
|
21
|
-
"PATCH /api/v1/orders/:id",
|
|
22
|
-
"PATCH /api/v1/orders/:id/cancel",
|
|
23
|
-
"PATCH /api/v1/orders/:id/external-id"
|
|
24
|
-
]
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
},
|
|
28
|
-
"products": {
|
|
29
|
-
"display_name": "Products",
|
|
30
|
-
"description": "Access and manage merchant products",
|
|
31
|
-
"scopes": {
|
|
32
|
-
"read_products": {
|
|
33
|
-
"label": "Read Products",
|
|
34
|
-
"description": "View products and product details",
|
|
35
|
-
"access": "read-only",
|
|
36
|
-
"endpoints": ["GET /api/v1/v1/products", "GET /api/v1/v1/products/:id"]
|
|
37
|
-
},
|
|
38
|
-
"write_products": {
|
|
39
|
-
"label": "Write Products",
|
|
40
|
-
"description": "Create, update, and delete products",
|
|
41
|
-
"access": "read-write",
|
|
42
|
-
"inherits": "read_products",
|
|
43
|
-
"endpoints": [
|
|
44
|
-
"POST /api/v1/v1/products",
|
|
45
|
-
"PUT /api/v1/v1/products/:id",
|
|
46
|
-
"DELETE /api/v1/v1/products/:id"
|
|
47
|
-
]
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
}
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 1,
|
|
3
|
-
"verification": {
|
|
4
|
-
"method": "HMAC-SHA256",
|
|
5
|
-
"header": "X-Ratio-Hmac-SHA256",
|
|
6
|
-
"description": "Verify webhook authenticity by computing HMAC-SHA256 of the raw request body using your app's client_secret as the key."
|
|
7
|
-
},
|
|
8
|
-
"retry_policy": {
|
|
9
|
-
"max_retries": 3,
|
|
10
|
-
"retry_intervals": ["5s", "30s", "5m"],
|
|
11
|
-
"failure_action": "Webhook is disabled after all retries fail"
|
|
12
|
-
},
|
|
13
|
-
"events": [
|
|
14
|
-
{
|
|
15
|
-
"topic": "orders/create",
|
|
16
|
-
"description": "Fired when a new order is created",
|
|
17
|
-
"resource": "orders",
|
|
18
|
-
"required_scope": "read_orders"
|
|
19
|
-
},
|
|
20
|
-
{
|
|
21
|
-
"topic": "orders/updated",
|
|
22
|
-
"description": "Fired when an order is updated",
|
|
23
|
-
"resource": "orders",
|
|
24
|
-
"required_scope": "read_orders"
|
|
25
|
-
},
|
|
26
|
-
{
|
|
27
|
-
"topic": "orders/cancelled",
|
|
28
|
-
"description": "Fired when an order is cancelled",
|
|
29
|
-
"resource": "orders",
|
|
30
|
-
"required_scope": "read_orders"
|
|
31
|
-
},
|
|
32
|
-
{
|
|
33
|
-
"topic": "orders/fulfilled",
|
|
34
|
-
"description": "Fired when an order is fulfilled",
|
|
35
|
-
"resource": "orders",
|
|
36
|
-
"required_scope": "read_orders"
|
|
37
|
-
},
|
|
38
|
-
{
|
|
39
|
-
"topic": "orders/paid",
|
|
40
|
-
"description": "Fired when an order is paid",
|
|
41
|
-
"resource": "orders",
|
|
42
|
-
"required_scope": "read_orders"
|
|
43
|
-
},
|
|
44
|
-
{
|
|
45
|
-
"topic": "products/create",
|
|
46
|
-
"description": "Fired when a new product is created",
|
|
47
|
-
"resource": "products",
|
|
48
|
-
"required_scope": "read_products"
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
"topic": "products/update",
|
|
52
|
-
"description": "Fired when a product is updated",
|
|
53
|
-
"resource": "products",
|
|
54
|
-
"required_scope": "read_products"
|
|
55
|
-
},
|
|
56
|
-
{
|
|
57
|
-
"topic": "products/delete",
|
|
58
|
-
"description": "Fired when a product is deleted",
|
|
59
|
-
"resource": "products",
|
|
60
|
-
"required_scope": "read_products"
|
|
61
|
-
},
|
|
62
|
-
{
|
|
63
|
-
"topic": "app/uninstalled",
|
|
64
|
-
"description": "Fired when the app is uninstalled by a merchant",
|
|
65
|
-
"resource": "app",
|
|
66
|
-
"required_scope": null
|
|
67
|
-
}
|
|
68
|
-
]
|
|
69
|
-
}
|
package/dist/schemas/scopes.json
DELETED
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 1,
|
|
3
|
-
"resources": {
|
|
4
|
-
"orders": {
|
|
5
|
-
"display_name": "Orders",
|
|
6
|
-
"description": "Access and manage merchant orders",
|
|
7
|
-
"scopes": {
|
|
8
|
-
"read_orders": {
|
|
9
|
-
"label": "Read Orders",
|
|
10
|
-
"description": "View orders and order details",
|
|
11
|
-
"access": "read-only",
|
|
12
|
-
"endpoints": ["GET /api/v1/orders", "GET /api/v1/orders/:id"]
|
|
13
|
-
},
|
|
14
|
-
"order-create": {
|
|
15
|
-
"label": "Order Create/Update",
|
|
16
|
-
"description": "Create, update, and cancel orders",
|
|
17
|
-
"access": "read-write",
|
|
18
|
-
"inherits": "read_orders",
|
|
19
|
-
"endpoints": [
|
|
20
|
-
"POST /api/v1/orders",
|
|
21
|
-
"PATCH /api/v1/orders/:id",
|
|
22
|
-
"PATCH /api/v1/orders/:id/cancel",
|
|
23
|
-
"PATCH /api/v1/orders/:id/external-id"
|
|
24
|
-
]
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
},
|
|
28
|
-
"products": {
|
|
29
|
-
"display_name": "Products",
|
|
30
|
-
"description": "Access and manage merchant products",
|
|
31
|
-
"scopes": {
|
|
32
|
-
"read_products": {
|
|
33
|
-
"label": "Read Products",
|
|
34
|
-
"description": "View products and product details",
|
|
35
|
-
"access": "read-only",
|
|
36
|
-
"endpoints": ["GET /api/v1/v1/products", "GET /api/v1/v1/products/:id"]
|
|
37
|
-
},
|
|
38
|
-
"write_products": {
|
|
39
|
-
"label": "Write Products",
|
|
40
|
-
"description": "Create, update, and delete products",
|
|
41
|
-
"access": "read-write",
|
|
42
|
-
"inherits": "read_products",
|
|
43
|
-
"endpoints": [
|
|
44
|
-
"POST /api/v1/v1/products",
|
|
45
|
-
"PUT /api/v1/v1/products/:id",
|
|
46
|
-
"DELETE /api/v1/v1/products/:id"
|
|
47
|
-
]
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
}
|