chore(docs): Generated References (#5743)
Generated the following references: - `entities` - `inventory` - `js-client` - `pricing` - `product` - `services` - `stock-location` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -13,8 +13,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Variables
|
||||
|
||||
### consumers
|
||||
#### consumers
|
||||
|
||||
___
|
||||
|
||||
### promises
|
||||
#### promises
|
||||
|
||||
@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Variables
|
||||
|
||||
### AvailableOrderIncludes
|
||||
#### AvailableOrderIncludes
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -26,9 +26,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
___
|
||||
|
||||
### PriceType
|
||||
#### PriceType
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -62,181 +62,325 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### allowedAdminProductCategoryRelations
|
||||
#### allowedAdminProductCategoryRelations
|
||||
|
||||
___
|
||||
|
||||
### allowedFields
|
||||
#### allowedFields
|
||||
|
||||
___
|
||||
|
||||
### allowedOrderIncludes
|
||||
#### allowedOrderIncludes
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreCustomersFields
|
||||
#### allowedStoreCustomersFields
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreCustomersRelations
|
||||
#### allowedStoreCustomersRelations
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreGiftCardFields
|
||||
#### allowedStoreGiftCardFields
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreGiftCardRelations
|
||||
#### allowedStoreGiftCardRelations
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreOrdersFields
|
||||
#### allowedStoreOrdersFields
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreOrdersRelations
|
||||
#### allowedStoreOrdersRelations
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreProductCategoryFields
|
||||
#### allowedStoreProductCategoryFields
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreProductTagFields
|
||||
#### allowedStoreProductTagFields
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreProductTypeFields
|
||||
#### allowedStoreProductTypeFields
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreProductsFields
|
||||
#### allowedStoreProductsFields
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreProductsRelations
|
||||
#### allowedStoreProductsRelations
|
||||
|
||||
___
|
||||
|
||||
### allowedStoreVariantRelations
|
||||
#### allowedStoreVariantRelations
|
||||
|
||||
___
|
||||
|
||||
### defaulPaymentCollectionRelations
|
||||
#### defaulPaymentCollectionRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminBatchFields
|
||||
#### defaultAdminBatchFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminCollectionsFields
|
||||
#### defaultAdminCollectionsFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminCollectionsRelations
|
||||
#### defaultAdminCollectionsRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminCustomerGroupsRelations
|
||||
#### defaultAdminCustomerGroupsRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminCustomersRelations
|
||||
#### defaultAdminCustomersRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminDiscountConditionFields
|
||||
#### defaultAdminDiscountConditionFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminDiscountConditionRelations
|
||||
#### defaultAdminDiscountConditionRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminDiscountsFields
|
||||
#### defaultAdminDiscountsFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminDiscountsRelations
|
||||
#### defaultAdminDiscountsRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminDraftOrdersCartFields
|
||||
#### defaultAdminDraftOrdersCartFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminDraftOrdersCartRelations
|
||||
#### defaultAdminDraftOrdersCartRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminDraftOrdersFields
|
||||
#### defaultAdminDraftOrdersFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminDraftOrdersRelations
|
||||
#### defaultAdminDraftOrdersRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminGetProductsVariantsFields
|
||||
#### defaultAdminGetProductsVariantsFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminGiftCardFields
|
||||
#### defaultAdminGiftCardFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminGiftCardRelations
|
||||
#### defaultAdminGiftCardRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminInventoryItemFields
|
||||
#### defaultAdminInventoryItemFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminInventoryItemRelations
|
||||
#### defaultAdminInventoryItemRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminLocationLevelFields
|
||||
#### defaultAdminLocationLevelFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminNotificationsFields
|
||||
#### defaultAdminNotificationsFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminNotificationsRelations
|
||||
#### defaultAdminNotificationsRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminPriceListFields
|
||||
#### defaultAdminPriceListFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminPriceListRelations
|
||||
#### defaultAdminPriceListRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminProductCategoryRelations
|
||||
#### defaultAdminPriceListRemoteQueryObject
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "fields",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rules",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rules.price_list_rule_values",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rules.price_list_rule_values.fields",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rules.rule_type",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rules.rule_type.fields",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts.money_amount",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts.money_amount.fields",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts.price_set",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts.price_set.variant_link",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts.price_set.variant_link.variant",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts.price_set.variant_link.variant.fields",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminProductFields
|
||||
#### defaultAdminProductCategoryRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminProductRelations
|
||||
#### defaultAdminProductFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminProductRemoteQueryObject
|
||||
#### defaultAdminProductRelations
|
||||
|
||||
___
|
||||
|
||||
#### defaultAdminProductRemoteQueryObject
|
||||
|
||||
This is temporary.
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "categories",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "categories.fields",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "collection",
|
||||
"type": "`object`",
|
||||
@@ -412,137 +556,137 @@ This is temporary.
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminProductTagsFields
|
||||
#### defaultAdminProductTagsFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminProductTagsRelations
|
||||
#### defaultAdminProductTagsRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminProductTypeFields
|
||||
#### defaultAdminProductTypeFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminProductTypeRelations
|
||||
#### defaultAdminProductTypeRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminRegionFields
|
||||
#### defaultAdminRegionFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminRegionRelations
|
||||
#### defaultAdminRegionRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminReservationRelations
|
||||
#### defaultAdminReservationRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminReturnReasonsFields
|
||||
#### defaultAdminReturnReasonsFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminReturnReasonsRelations
|
||||
#### defaultAdminReturnReasonsRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminShippingProfilesFields
|
||||
#### defaultAdminShippingProfilesFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminShippingProfilesRelations
|
||||
#### defaultAdminShippingProfilesRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminStockLocationFields
|
||||
#### defaultAdminStockLocationFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminStockLocationRelations
|
||||
#### defaultAdminStockLocationRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminSwapFields
|
||||
#### defaultAdminSwapFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminSwapRelations
|
||||
#### defaultAdminSwapRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminTaxRatesFields
|
||||
#### defaultAdminTaxRatesFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminTaxRatesRelations
|
||||
#### defaultAdminTaxRatesRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminVariantFields
|
||||
#### defaultAdminVariantFields
|
||||
|
||||
___
|
||||
|
||||
### defaultAdminVariantRelations
|
||||
#### defaultAdminVariantRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultFields
|
||||
#### defaultFields
|
||||
|
||||
___
|
||||
|
||||
### defaultPaymentCollectionFields
|
||||
#### defaultPaymentCollectionFields
|
||||
|
||||
___
|
||||
|
||||
### defaultPaymentCollectionRelations
|
||||
#### defaultPaymentCollectionRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultPaymentFields
|
||||
#### defaultPaymentFields
|
||||
|
||||
___
|
||||
|
||||
### defaultProductCategoryFields
|
||||
#### defaultProductCategoryFields
|
||||
|
||||
___
|
||||
|
||||
### defaultRelations
|
||||
#### defaultRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultRelationsExtended
|
||||
#### defaultRelationsExtended
|
||||
|
||||
___
|
||||
|
||||
### defaultRelationsList
|
||||
#### defaultRelationsList
|
||||
|
||||
___
|
||||
|
||||
### defaultReservationFields
|
||||
#### defaultReservationFields
|
||||
|
||||
___
|
||||
|
||||
### defaultReturnCancelFields
|
||||
#### defaultReturnCancelFields
|
||||
|
||||
___
|
||||
|
||||
### defaultReturnCancelRelations
|
||||
#### defaultReturnCancelRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreCartFields
|
||||
#### defaultStoreCartFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreCartRelations
|
||||
#### defaultStoreCartRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreCategoryScope
|
||||
#### defaultStoreCategoryScope
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -567,47 +711,47 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreCollectionRelations
|
||||
#### defaultStoreCollectionRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreCustomersFields
|
||||
#### defaultStoreCustomersFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreCustomersRelations
|
||||
#### defaultStoreCustomersRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreGiftCardFields
|
||||
#### defaultStoreGiftCardFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreGiftCardRelations
|
||||
#### defaultStoreGiftCardRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreOrdersFields
|
||||
#### defaultStoreOrdersFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreOrdersRelations
|
||||
#### defaultStoreOrdersRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductCategoryFields
|
||||
#### defaultStoreProductCategoryFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductCategoryRelations
|
||||
#### defaultStoreProductCategoryRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductRemoteQueryObject
|
||||
#### defaultStoreProductRemoteQueryObject
|
||||
|
||||
This is temporary.
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -785,52 +929,52 @@ This is temporary.
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductTagFields
|
||||
#### defaultStoreProductTagFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductTagRelations
|
||||
#### defaultStoreProductTagRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductTypeFields
|
||||
#### defaultStoreProductTypeFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductTypeRelations
|
||||
#### defaultStoreProductTypeRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductsFields
|
||||
#### defaultStoreProductsFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreProductsRelations
|
||||
#### defaultStoreProductsRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreReturnReasonFields
|
||||
#### defaultStoreReturnReasonFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreReturnReasonRelations
|
||||
#### defaultStoreReturnReasonRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreSwapFields
|
||||
#### defaultStoreSwapFields
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreSwapRelations
|
||||
#### defaultStoreSwapRelations
|
||||
|
||||
___
|
||||
|
||||
### defaultStoreVariantRelations
|
||||
#### defaultStoreVariantRelations
|
||||
|
||||
___
|
||||
|
||||
### filterableAdminOrdersFields
|
||||
#### filterableAdminOrdersFields
|
||||
|
||||
___
|
||||
|
||||
### joinerConfig
|
||||
#### joinerConfig
|
||||
|
||||
Reference in New Issue
Block a user