chore: reorganize docs apps (#7228)

* reorganize docs apps

* add README

* fix directory

* add condition for old docs
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-05-03 17:36:38 +03:00
1 parent 224ebb2154
commit 4fe28f5a95
6187 files changed
+601447 -598226

No files matched your search

@@ -0,0 +1,21 @@
import { TypeList } from "docs-ui"
# GeoZoneType
## Enumeration Members
### COUNTRY
**COUNTRY** = `"country"`
### PROVINCE
**PROVINCE** = `"province"`
### CITY
**CITY** = `"city"`
### ZIP
**ZIP** = `"zip"`
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# ShippingOptionPriceType
## Enumeration Members
### CALCULATED
**CALCULATED** = `"calculated"`
### FLAT
**FLAT** = `"flat"`
@@ -0,0 +1,37 @@
import { TypeList } from "docs-ui"
# OrderChangeStatus
The order change's status.
## Enumeration Members
### CONFIRMED
**CONFIRMED** = `"confirmed"`
The order change is confirmed.
### DECLINED
**DECLINED** = `"declined"`
The order change is declined.
### REQUESTED
**REQUESTED** = `"requested"`
The order change is requested.
### PENDING
**PENDING** = `"pending"`
The order change is pending.
### CANCELED
**CANCELED** = `"canceled"`
The order change is canceled.
@@ -0,0 +1,43 @@
import { TypeList } from "docs-ui"
# OrderStatus
The order's status.
## Enumeration Members
### PENDING
**PENDING** = `"pending"`
The order is pending.
### COMPLETED
**COMPLETED** = `"completed"`
The order is completed
### DRAFT
**DRAFT** = `"draft"`
The order is a draft.
### ARCHIVED
**ARCHIVED** = `"archived"`
The order is archived.
### CANCELED
**CANCELED** = `"canceled"`
The order is canceled.
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
The order requires action.
@@ -0,0 +1,21 @@
import { TypeList } from "docs-ui"
# ProductStatus
## Enumeration Members
### DRAFT
**DRAFT** = `"draft"`
### PROPOSED
**PROPOSED** = `"proposed"`
### PUBLISHED
**PUBLISHED** = `"published"`
### REJECTED
**REJECTED** = `"rejected"`
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# ApplicationMethodAllocation
## Enumeration Members
### EACH
**EACH** = `"each"`
### ACROSS
**ACROSS** = `"across"`
@@ -0,0 +1,17 @@
import { TypeList } from "docs-ui"
# ApplicationMethodTargetType
## Enumeration Members
### ORDER
**ORDER** = `"order"`
### SHIPPING\_METHODS
**SHIPPING\_METHODS** = `"shipping_methods"`
### ITEMS
**ITEMS** = `"items"`
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# ApplicationMethodType
## Enumeration Members
### FIXED
**FIXED** = `"fixed"`
### PERCENTAGE
**PERCENTAGE** = `"percentage"`
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# CampaignBudgetType
## Enumeration Members
### SPEND
**SPEND** = `"spend"`
### USAGE
**USAGE** = `"usage"`
@@ -0,0 +1,25 @@
import { TypeList } from "docs-ui"
# ComputedActions
## Enumeration Members
### ADD\_ITEM\_ADJUSTMENT
**ADD\_ITEM\_ADJUSTMENT** = `"addItemAdjustment"`
### ADD\_SHIPPING\_METHOD\_ADJUSTMENT
**ADD\_SHIPPING\_METHOD\_ADJUSTMENT** = `"addShippingMethodAdjustment"`
### REMOVE\_ITEM\_ADJUSTMENT
**REMOVE\_ITEM\_ADJUSTMENT** = `"removeItemAdjustment"`
### REMOVE\_SHIPPING\_METHOD\_ADJUSTMENT
**REMOVE\_SHIPPING\_METHOD\_ADJUSTMENT** = `"removeShippingMethodAdjustment"`
### CAMPAIGN\_BUDGET\_EXCEEDED
**CAMPAIGN\_BUDGET\_EXCEEDED** = `"campaignBudgetExceeded"`
@@ -0,0 +1,17 @@
import { TypeList } from "docs-ui"
# PromotionActions
## Enumeration Members
### ADD
**ADD** = `"add"`
### REMOVE
**REMOVE** = `"remove"`
### REPLACE
**REPLACE** = `"replace"`
@@ -0,0 +1,33 @@
import { TypeList } from "docs-ui"
# PromotionRuleOperator
## Enumeration Members
### GTE
**GTE** = `"gte"`
### LTE
**LTE** = `"lte"`
### GT
**GT** = `"gt"`
### LT
**LT** = `"lt"`
### EQ
**EQ** = `"eq"`
### NE
**NE** = `"ne"`
### IN
**IN** = `"in"`
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# PromotionType
## Enumeration Members
### STANDARD
**STANDARD** = `"standard"`
### BUYGET
**BUYGET** = `"buyget"`
@@ -0,0 +1,17 @@
import { TypeList } from "docs-ui"
# RuleType
## Enumeration Members
### RULES
**RULES** = `"rules"`
### TARGET\_RULES
**TARGET\_RULES** = `"target_rules"`
### BUY\_RULES
**BUY\_RULES** = `"buy_rules"`
@@ -0,0 +1,17 @@
import { TypeList } from "docs-ui"
# ShippingProfileType
## Enumeration Members
### DEFAULT
**DEFAULT** = `"default"`
### GIFT\_CARD
**GIFT\_CARD** = `"gift_card"`
### CUSTOM
**CUSTOM** = `"custom"`
@@ -0,0 +1,31 @@
import { TypeList } from "docs-ui"
# PaymentActions
Normalized events from payment provider to internal payment module events.
## Enumeration Members
### AUTHORIZED
**AUTHORIZED** = `"authorized"`
Payment session has been authorized and there are available funds for capture.
### SUCCESSFUL
**SUCCESSFUL** = `"captured"`
Payment was successful and the mount is captured.
### FAILED
**FAILED** = `"failed"`
Payment failed.
### NOT\_SUPPORTED
**NOT\_SUPPORTED** = `"not_supported"`
Received an event that is not processable.
@@ -0,0 +1,37 @@
import { TypeList } from "docs-ui"
# PaymentCollectionStatus
The payment collection's status.
## Enumeration Members
### NOT\_PAID
**NOT\_PAID** = `"not_paid"`
The payment collection isn't paid.
### AWAITING
**AWAITING** = `"awaiting"`
The payment collection is awaiting payment.
### AUTHORIZED
**AUTHORIZED** = `"authorized"`
The payment collection is authorized.
### PARTIALLY\_AUTHORIZED
**PARTIALLY\_AUTHORIZED** = `"partially_authorized"`
Some of the payments in the payment collection are authorized.
### CANCELED
**CANCELED** = `"canceled"`
The payment collection is canceled.
@@ -0,0 +1,37 @@
import { TypeList } from "docs-ui"
# PaymentSessionStatus
The status of a payment session.
## Enumeration Members
### AUTHORIZED
**AUTHORIZED** = `"authorized"`
The payment is authorized.
### PENDING
**PENDING** = `"pending"`
The payment is pending.
### REQUIRES\_MORE
**REQUIRES\_MORE** = `"requires_more"`
The payment requires an action.
### ERROR
**ERROR** = `"error"`
An error occurred while processing the payment.
### CANCELED
**CANCELED** = `"canceled"`
The payment is canceled.
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# PaymentWebhookEvents
## Enumeration Members
### WebhookReceived
**WebhookReceived** = `"payment.webhook_received"`
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# PriceListStatus
## Enumeration Members
### ACTIVE
**ACTIVE** = `"active"`
### DRAFT
**DRAFT** = `"draft"`
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# PriceListType
## Enumeration Members
### SALE
**SALE** = `"sale"`
### OVERRIDE
**OVERRIDE** = `"override"`
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# RuleAttributeInput
**RuleAttributeInput**: `string` \| `undefined`
@@ -0,0 +1,16 @@
import { TypeList } from "docs-ui"
# FulfillmentUtils
## Enumerations
- [GeoZoneType](../FulfillmentUtils/enums/utils.FulfillmentUtils.GeoZoneType/page.mdx)
- [ShippingOptionPriceType](../FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)
___
## Variables
### FulfillmentEvents
`Const` **FulfillmentEvents**: `object` & `object` & `object` & `object` & `object` & `object` & `object`
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# InventoryUtils
## Variables
### InventoryEvents
`Const` **InventoryEvents**: `Object`
#### Properties
<TypeList types={[{"name":"created","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"restored","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reservation_item_created","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reservation_item_updated","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reservation_item_deleted","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_level_deleted","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_level_created","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_level_updated","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InventoryEvents"/>
@@ -0,0 +1,37 @@
import { TypeList } from "docs-ui"
# LinkUtils
## Variables
### LINKS
`Const` **LINKS**: `Object`
#### Properties
<TypeList types={[{"name":"ProductVariantInventoryItem","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ProductVariantPriceSet","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ShippingOptionPriceSet","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CartPaymentCollection","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"RegionPaymentProvider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CartPromotion","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SalesChannelLocation","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FulfillmentSetLocation","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderPromotion","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderSalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"PublishableApiKeySalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ProductShippingProfile","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ProductSalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="LINKS"/>
___
## Functions
### composeLinkName
#### Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="composeLinkName"/>
#### Returns
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="composeLinkName"/>
### composeTableName
#### Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="composeTableName"/>
#### Returns
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="composeTableName"/>
@@ -0,0 +1,8 @@
import { TypeList } from "docs-ui"
# OrderUtils
## Enumerations
- [OrderStatus](../OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)
- [OrderChangeStatus](../OrderUtils/enums/utils.OrderUtils.OrderChangeStatus/page.mdx)
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ProductUtils
## Enumerations
- [ProductStatus](../ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)
@@ -0,0 +1,15 @@
import { TypeList } from "docs-ui"
# PromotionUtils
## Enumerations
- [PromotionType](../PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)
- [ApplicationMethodType](../PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)
- [ApplicationMethodTargetType](../PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)
- [ApplicationMethodAllocation](../PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodAllocation/page.mdx)
- [PromotionRuleOperator](../PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)
- [CampaignBudgetType](../PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx)
- [ComputedActions](../PromotionUtils/enums/utils.PromotionUtils.ComputedActions/page.mdx)
- [PromotionActions](../PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx)
- [RuleType](../PromotionUtils/enums/utils.PromotionUtils.RuleType/page.mdx)
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ShippingProfileUtils
## Enumerations
- [ShippingProfileType](../ShippingProfileUtils/enums/utils.ShippingProfileUtils.ShippingProfileType/page.mdx)
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# UserUtils
## Variables
### UserEvents
`Const` **UserEvents**: `Object`
#### Properties
<TypeList types={[{"name":"created","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invite_created","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invite_updated","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invite_token_generated","type":"`string`","description":"","optional":false,"defaultValue":"\"invite.token_generated\"","expandable":false,"children":[]}]} sectionTitle="UserEvents"/>